My Quote Requests
The My Quote Requests API creates and provides access to Quote Requests scoped to a specific Customer.
The API requires an access token from the password flow or anonymous session flow.
Representations
MyQuoteRequestDraft
cartId String |
|
cartVersion Int | Current version of the Cart. |
comment String | Message from the Buyer included in the Quote Request. |
Query QuoteRequests
manage_my_quote_requests:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String |
|
where | The parameter can be passed multiple times. |
/^var[.][a-zA-Z0-9]+$/ Any string parameter matching this regular expression | Predicate parameter values. 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. |
offset Int | Number of elements skipped. |
withTotal Boolean | Controls the calculation of the total number of query results. Set to |
curl --get https://api.{region}.commercetools.com/{projectKey}/me/quote-requests -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","quoteRequestState" : "Submitted","comment" : "Give me 10% discount","customer" : {"typeId" : "customer","id" : "92f5a867-bf19-47ab-982c-6720a03a3921"},"lineItems" : [ {"id" : "b925a817-d5ad-48bb-a407-29ad8e0649b5","productId" : "9f10dcfb-5cc9-4a18-843a-c07f7e22d01f","name" : {"en" : "SAPPHIRE"},"productType" : {"typeId" : "product-type","id" : "2543e1d8-4915-4f72-a3c9-1df9b1b0082d","version" : 8},"productSlug" : {"en" : "sapphire1421832124423"},"variant" : {"id" : 1,"sku" : "sku_SAPPHIRE_variant1_1421832124423","prices" : [ {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"} ],"images" : [ {"url" : "https://www.commercetools.com/cli/data/252542005_1.jpg","dimensions" : {"w" : 1400,"h" : 1400}} ],"attributes" : [ ],"assets" : [ ]},"price" : {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"},"quantity" : 2,"discountedPricePerQuantity" : [ ],"state" : [ {"quantity" : 2,"state" : {"typeId" : "state","id" : "7c2e2694-aefe-43d7-888e-6a99514caaca"}} ],"priceMode" : "Platform","lineItemMode" : "Standard","totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"perMethodTaxRate" : [ ],"taxedPricePortions" : [ ]} ],"totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"customLineItems" : [ ],"directDiscounts" : [ ],"inventoryMode" : "None","taxMode" : "Platform","taxRoundingMode" : "HalfEven","taxCalculationMode" : "LineItemLevel"}, {"id" : "668e5783-73c8-4f2d-91f4-3c90b872c700","version" : 2,"createdAt" : "2022-09-22T15:36:17.510Z","lastModifiedAt" : "2022-09-22T15:41:55.816Z","quoteRequestState" : "Rejected","comment" : "Give me 100€ off discount","customer" : {"typeId" : "customer","id" : "92f5a867-bf19-47ab-982c-6720a03a3921"},"lineItems" : [ {"id" : "90dff06c-272e-47fa-b8de-923dce092474","productId" : "7b1203f4-66c0-438c-9a30-f4fb6be79bdf","name" : {"de" : "WB ATHLETIC PANZER","en" : "WB ATHLETIC TANK"},"productType" : {"typeId" : "product-type","id" : "2543e1d8-4915-4f72-a3c9-1df9b1b0082d","version" : 8},"productSlug" : {"en" : "wb-athletic-tank1421832124574"},"variant" : {"id" : 1,"sku" : "sku_WB_ATHLETIC_TANK_variant1_1421832124574","prices" : [ {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 8400},"id" : "37696f7c-8260-4941-a921-68e6aa76b4a3"} ],"images" : [ {"url" : "https://www.commercetools.com/cli/data/253265444_1.jpg","dimensions" : {"w" : 1400,"h" : 1400}} ],"attributes" : [ ],"assets" : [ ]},"price" : {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 8400},"id" : "37696f7c-8260-4941-a921-68e6aa76b4a3"},"quantity" : 1,"discountedPricePerQuantity" : [ ],"state" : [ {"quantity" : 1,"state" : {"typeId" : "state","id" : "7c2e2694-aefe-43d7-888e-6a99514caaca"}} ],"priceMode" : "Platform","lineItemMode" : "Standard","totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 8400},"custom" : {"type" : {"typeId" : "type","id" : "3ae9bcca-df23-443e-bd22-0c592f9694fa"},"fields" : {"offer_name" : "SuperMax"}},"perMethodTaxRate" : [ ],"taxedPricePortions" : [ ]} ],"totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 8400},"country" : "DE","customLineItems" : [ ],"directDiscounts" : [ ],"inventoryMode" : "None","taxMode" : "Platform","taxRoundingMode" : "HalfEven","taxCalculationMode" : "LineItemLevel"} ]}
Create QuoteRequest
manage_my_quote_requests:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String |
|
expand | The parameter can be passed multiple times. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/quote-requests -i \--header 'Authorization: Bearer ${BEARER_TOKEN}' \--header 'Content-Type: application/json' \--data-binary @- << DATA{"cartId" : "168e5783-73c8-4f2d-91f4-3c90b872c708","cartVersion" : 1,"comment" : "Give me 10% discount"}DATA
{"id" : "2a3baa00-44fa-4ab8-bec7-933c31e18dcc","version" : 1,"createdAt" : "2022-09-22T15:36:17.510Z","lastModifiedAt" : "2022-09-22T15:41:55.816Z","quoteRequestState" : "Submitted","comment" : "Give me 10% discount","customer" : {"typeId" : "customer","id" : "92f5a867-bf19-47ab-982c-6720a03a3921"},"lineItems" : [ {"id" : "b925a817-d5ad-48bb-a407-29ad8e0649b5","productId" : "9f10dcfb-5cc9-4a18-843a-c07f7e22d01f","name" : {"en" : "SAPPHIRE"},"productType" : {"typeId" : "product-type","id" : "2543e1d8-4915-4f72-a3c9-1df9b1b0082d","version" : 8},"productSlug" : {"en" : "sapphire1421832124423"},"variant" : {"id" : 1,"sku" : "sku_SAPPHIRE_variant1_1421832124423","prices" : [ {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"} ],"images" : [ {"url" : "https://www.commercetools.com/cli/data/252542005_1.jpg","dimensions" : {"w" : 1400,"h" : 1400}} ],"attributes" : [ ],"assets" : [ ]},"price" : {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"},"quantity" : 2,"discountedPricePerQuantity" : [ ],"state" : [ {"quantity" : 2,"state" : {"typeId" : "state","id" : "7c2e2694-aefe-43d7-888e-6a99514caaca"}} ],"priceMode" : "Platform","lineItemMode" : "Standard","totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"perMethodTaxRate" : [ ],"taxedPricePortions" : [ ]} ],"totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"customLineItems" : [ ],"directDiscounts" : [ ],"inventoryMode" : "None","taxMode" : "Platform","taxRoundingMode" : "HalfEven","taxCalculationMode" : "LineItemLevel"}
Update QuoteRequest
Update QuoteRequest by ID
manage_my_quote_requests:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String |
|
id String |
|
expand | The parameter can be passed multiple times. |
application/json
version Int | |
actions Array of MyQuoteRequestUpdateAction |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/quote-requests/{id} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}' \--header 'Content-Type: application/json' \--data-binary @- << DATA{"version" : 1,"actions" : [ {"action" : "cancelQuoteRequest"} ]}DATA
{"id" : "2a3baa00-44fa-4ab8-bec7-933c31e18dcc","version" : 1,"createdAt" : "2022-09-22T15:36:17.510Z","lastModifiedAt" : "2022-09-22T15:41:55.816Z","quoteRequestState" : "Cancelled","comment" : "Give me 10% discount","customer" : {"typeId" : "customer","id" : "92f5a867-bf19-47ab-982c-6720a03a3921"},"lineItems" : [ {"id" : "b925a817-d5ad-48bb-a407-29ad8e0649b5","productId" : "9f10dcfb-5cc9-4a18-843a-c07f7e22d01f","name" : {"en" : "SAPPHIRE"},"productType" : {"typeId" : "product-type","id" : "2543e1d8-4915-4f72-a3c9-1df9b1b0082d","version" : 8},"productSlug" : {"en" : "sapphire1421832124423"},"variant" : {"id" : 1,"sku" : "sku_SAPPHIRE_variant1_1421832124423","prices" : [ {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"} ],"images" : [ {"url" : "https://www.commercetools.com/cli/data/252542005_1.jpg","dimensions" : {"w" : 1400,"h" : 1400}} ],"attributes" : [ ],"assets" : [ ]},"price" : {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"},"quantity" : 2,"discountedPricePerQuantity" : [ ],"state" : [ {"quantity" : 2,"state" : {"typeId" : "state","id" : "7c2e2694-aefe-43d7-888e-6a99514caaca"}} ],"priceMode" : "Platform","lineItemMode" : "Standard","totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"perMethodTaxRate" : [ ],"taxedPricePortions" : [ ]} ],"totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"customLineItems" : [ ],"directDiscounts" : [ ],"inventoryMode" : "None","taxMode" : "Platform","taxRoundingMode" : "HalfEven","taxCalculationMode" : "LineItemLevel"}
Update QuoteRequest by Key
manage_my_quote_requests:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String |
|
key String |
|
expand | The parameter can be passed multiple times. |
application/json
version Int | |
actions Array of MyQuoteRequestUpdateAction |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/me/quote-requests/key={key} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}' \--header 'Content-Type: application/json' \--data-binary @- << DATA{"version" : 1,"actions" : [ {"action" : "cancelQuoteRequest"} ]}DATA
{"id" : "2a3baa00-44fa-4ab8-bec7-933c31e18dcc","version" : 1,"createdAt" : "2022-09-22T15:36:17.510Z","lastModifiedAt" : "2022-09-22T15:41:55.816Z","quoteRequestState" : "Cancelled","comment" : "Give me 10% discount","customer" : {"typeId" : "customer","id" : "92f5a867-bf19-47ab-982c-6720a03a3921"},"lineItems" : [ {"id" : "b925a817-d5ad-48bb-a407-29ad8e0649b5","productId" : "9f10dcfb-5cc9-4a18-843a-c07f7e22d01f","name" : {"en" : "SAPPHIRE"},"productType" : {"typeId" : "product-type","id" : "2543e1d8-4915-4f72-a3c9-1df9b1b0082d","version" : 8},"productSlug" : {"en" : "sapphire1421832124423"},"variant" : {"id" : 1,"sku" : "sku_SAPPHIRE_variant1_1421832124423","prices" : [ {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"} ],"images" : [ {"url" : "https://www.commercetools.com/cli/data/252542005_1.jpg","dimensions" : {"w" : 1400,"h" : 1400}} ],"attributes" : [ ],"assets" : [ ]},"price" : {"value" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 2800},"id" : "8da659ef-9e54-447d-9c36-84912db1848f"},"quantity" : 2,"discountedPricePerQuantity" : [ ],"state" : [ {"quantity" : 2,"state" : {"typeId" : "state","id" : "7c2e2694-aefe-43d7-888e-6a99514caaca"}} ],"priceMode" : "Platform","lineItemMode" : "Standard","totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"perMethodTaxRate" : [ ],"taxedPricePortions" : [ ]} ],"totalPrice" : {"type" : "centPrecision","fractionDigits" : 2,"currencyCode" : "EUR","centAmount" : 5600},"customLineItems" : [ ],"directDiscounts" : [ ],"inventoryMode" : "None","taxMode" : "Platform","taxRoundingMode" : "HalfEven","taxCalculationMode" : "LineItemLevel"}
Update actions
Cancel Quote Request
Transitions the quoteRequestState
of the Quote Request to Cancelled
. Can only be used when the Quote Request is in state Submitted
.
action String | "cancelQuoteRequest" |
Set Custom Type
action String | "setCustomType" |
type | Defines the Type that extends the QuoteRequest with Custom Fields. If absent, any existing Type and Custom Fields are removed from the QuoteRequest. |
fields | Sets the Custom Fields fields for the QuoteRequest. |
{"action" : "setCustomType","type" : {"id" : "{{type-id}}","typeId" : "type"},"fields" : {"exampleStringTypeField" : "TextString"}}
Set Custom Field
action String | "setCustomField" |
name String | Name of the Custom Field. |
value | If |
{"action" : "setCustomField","name" : "ExampleStringTypeField","value" : "TextString"}