Skip to main content
Server path: /commercetools-quotes | Type: Application | PCID required: Yes

Tools

ToolDescription
commercetools_quotes_create_quote_requestsCreates a QuoteRequest in the Project.
commercetools_quotes_create_quotesCreates a Quote in the Project.
commercetools_quotes_create_recurrence_policiesCreates a Recurrence Policy in the Project. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_create_recurring_ordersCreates a Recurring Order in the Project. Produces the RecurringOrderCreated message. The Cart is validated to ensure that it is convertible to an Order. If the validation fails, an error is returned. If the expiration date has been reached when the Recurring Order is processed, its RecurringOrderState will be updated to Expired, and no Order will be created. If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Recurring Order creation may still successfully complete after the error is returned. If you receive this error, you should verify the status of the Recurring Order by querying a unique identifier supplied during the creation request, such as the key.
commercetools_quotes_create_staged_quotesCreates a StagedQuote in the Project.
commercetools_quotes_delete_by_idDeletes a Quote in the Project.
commercetools_quotes_delete_by_keyDeletes a Quote in the Project.
commercetools_quotes_delete_quote_requests_by_idDeletes a QuoteRequest in the Project.
commercetools_quotes_delete_quote_requests_by_keyDeletes a QuoteRequest in the Project.
commercetools_quotes_delete_recurrence_policies_by_idDeletes a Recurrence Policy in the Project. A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a ReferenceExists error is returned. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_delete_recurrence_policies_by_keyDeletes a Recurrence Policy in the Project. A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a ReferenceExists error is returned. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_delete_recurring_orders_by_idDeletes a Recurring Order in the Project.
commercetools_quotes_delete_recurring_orders_by_keyDeletes a Recurring Order in the Project.
commercetools_quotes_delete_staged_quotes_by_idDeletes a StagedQuote in the Project.
commercetools_quotes_delete_staged_quotes_by_keyDeletes a StagedQuote in the Project.
commercetools_quotes_get_by_idRetrieves a Quote with the provided id.
commercetools_quotes_get_by_keyRetrieves a Quote with the provided key.
commercetools_quotes_get_quote_requests_by_idRetrieves a QuoteRequest with the provided id.
commercetools_quotes_get_quote_requests_by_keyRetrieves a QuoteRequest with the provided key.
commercetools_quotes_get_recurrence_policies_by_idRetrieves a Recurrence Policy with the provided id. The view_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the view_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_get_recurrence_policies_by_keyRetrieves a Recurrence Policy with the provided key. The view_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the view_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_get_recurring_orders_by_idRetrieves a Recurring Order with the provided id.
commercetools_quotes_get_recurring_orders_by_keyRetrieves a Recurring Order with the provided key.
commercetools_quotes_get_staged_quotes_by_idRetrieves a StagedQuote with the provided id.
commercetools_quotes_get_staged_quotes_by_keyRetrieves a StagedQuote with the provided key.
commercetools_quotes_list_quote_requestsRetrieves all QuoteRequests in the Project.
commercetools_quotes_list_quotesRetrieves all Quotes in the Project.
commercetools_quotes_list_recurrence_policiesRetrieves Recurrence Policies in the Project. The view_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the view_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_list_recurring_ordersRetrieves Recurring Orders in the Project.
commercetools_quotes_list_staged_quotesRetrieves all StagedQuotes in the Project.
commercetools_quotes_update_quote_requests_by_idUpdates a QuoteRequest in the Project using one or more update actions.
commercetools_quotes_update_quote_requests_by_keyUpdates a QuoteRequest in the Project using one or more update actions.
commercetools_quotes_update_quotes_by_idUpdates a Quote in the Project using one or more update actions.
commercetools_quotes_update_quotes_by_keyUpdates a Quote in the Project using one or more update actions.
commercetools_quotes_update_recurrence_policies_by_idUpdates a Recurrence Policy using one or more update actions. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_update_recurrence_policies_by_keyUpdates a Recurrence Policy using one or more update actions. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list.
commercetools_quotes_update_recurring_orders_by_idUpdates a Recurring Order using one or more update actions. A Recurring Order can only be updated when it is not processing an Order. Otherwise, an InvalidOperation error is returned.
commercetools_quotes_update_recurring_orders_by_keyUpdates a Recurring Order using one or more update actions. A Recurring Order can only be updated when it is not processing an Order. Otherwise, an InvalidOperation error is returned.
commercetools_quotes_update_staged_quotes_by_idUpdates a StagedQuote in the Project using one or more update actions.
commercetools_quotes_update_staged_quotes_by_keyUpdates a StagedQuote in the Project using one or more update actions.

commercetools_quotes_create_quote_requests

Creates a QuoteRequest in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
cartobjectYesThe cart value
cartVersionintegerYesCart Version
commentstringNoThe comment value
customobjectNoThe custom value
keystringNoThe key value
purchaseOrderNumberstringNoPurchase Order Number
stateobjectNoThe state value

commercetools_quotes_create_quotes

Creates a Quote in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
customobjectNoThe custom value
keystringNoThe key value
stagedQuoteobjectYesStaged Quote
stagedQuoteStateToSentbooleanNoStaged Quote State To Sent
stagedQuoteVersionintegerYesStaged Quote Version
stateobjectNoThe state value

commercetools_quotes_create_recurrence_policies

Creates a Recurrence Policy in the Project. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
descriptionobjectNoThe description value
keystringYesThe key value
nameobjectNoThe name value
scheduleobjectYesThe schedule value

commercetools_quotes_create_recurring_orders

Creates a Recurring Order in the Project. Produces the RecurringOrderCreated message. The Cart is validated to ensure that it is convertible to an Order. If the validation fails, an error is returned. If the expiration date has been reached when the Recurring Order is processed, its RecurringOrderState will be updated to Expired, and no Order will be created. If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Recurring Order creation may still successfully complete after the error is returned. If you receive this error, you should verify the status of the Recurring Order by querying a unique identifier supplied during the creation request, such as the key. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
cartobjectYesThe cart value
cartVersionintegerYesCart Version
customobjectNoThe custom value
expiresAtstringNoExpires At
keystringNoThe key value
startsAtstringNoStarts At
stateobjectNoThe state value

commercetools_quotes_create_staged_quotes

Creates a StagedQuote in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
customobjectNoThe custom value
keystringNoThe key value
quoteRequestobjectYesQuote Request
quoteRequestStateToAcceptedbooleanNoQuote Request State To Accepted
quoteRequestVersionintegerYesQuote Request Version
stateobjectNoThe state value

commercetools_quotes_delete_by_id

Deletes a Quote in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_by_key

Deletes a Quote in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_quote_requests_by_id

Deletes a QuoteRequest in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_quote_requests_by_key

Deletes a QuoteRequest in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_recurrence_policies_by_id

Deletes a Recurrence Policy in the Project. A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a ReferenceExists error is returned. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_recurrence_policies_by_key

Deletes a Recurrence Policy in the Project. A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a ReferenceExists error is returned. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_recurring_orders_by_id

Deletes a Recurring Order in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_recurring_orders_by_key

Deletes a Recurring Order in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_staged_quotes_by_id

Deletes a StagedQuote in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_delete_staged_quotes_by_key

Deletes a StagedQuote in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_by_id

Retrieves a Quote with the provided id. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_by_key

Retrieves a Quote with the provided key. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_quote_requests_by_id

Retrieves a QuoteRequest with the provided id. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_quote_requests_by_key

Retrieves a QuoteRequest with the provided key. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_recurrence_policies_by_id

Retrieves a Recurrence Policy with the provided id. The view_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the view_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_recurrence_policies_by_key

Retrieves a Recurrence Policy with the provided key. The view_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the view_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_recurring_orders_by_id

Retrieves a Recurring Order with the provided id. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_recurring_orders_by_key

Retrieves a Recurring Order with the provided key. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_staged_quotes_by_id

Retrieves a StagedQuote with the provided id. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_get_staged_quotes_by_key

Retrieves a StagedQuote with the provided key. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_quotes_list_quote_requests

Retrieves all QuoteRequests in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_quotes_list_quotes

Retrieves all Quotes in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_quotes_list_recurrence_policies

Retrieves Recurrence Policies in the Project. The view_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the view_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_quotes_list_recurring_orders

Retrieves Recurring Orders in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_quotes_list_staged_quotes

Retrieves all StagedQuotes in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_quotes_update_quote_requests_by_id

Updates a QuoteRequest in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_quote_requests_by_key

Updates a QuoteRequest in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_quotes_by_id

Updates a Quote in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_quotes_by_key

Updates a Quote in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_recurrence_policies_by_id

Updates a Recurrence Policy using one or more update actions. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_recurrence_policies_by_key

Updates a Recurrence Policy using one or more update actions. The manage_recurring_orders:{projectKey} scope is deprecated for use on this endpoint. Update your clients to use the manage_recurrence_policies:{projectKey} scope instead. For more information, see the Deprecations and removals list. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_recurring_orders_by_id

Updates a Recurring Order using one or more update actions. A Recurring Order can only be updated when it is not processing an Order. Otherwise, an InvalidOperation error is returned. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_recurring_orders_by_key

Updates a Recurring Order using one or more update actions. A Recurring Order can only be updated when it is not processing an Order. Otherwise, an InvalidOperation error is returned. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_staged_quotes_by_id

Updates a StagedQuote in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_quotes_update_staged_quotes_by_key

Updates a StagedQuote in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value