/commercetools-quotes | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
commercetools_quotes_create_quote_requests | Creates a QuoteRequest in the Project. |
commercetools_quotes_create_quotes | Creates a Quote in the Project. |
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. |
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. |
commercetools_quotes_create_staged_quotes | Creates a StagedQuote in the Project. |
commercetools_quotes_delete_by_id | Deletes a Quote in the Project. |
commercetools_quotes_delete_by_key | Deletes a Quote in the Project. |
commercetools_quotes_delete_quote_requests_by_id | Deletes a QuoteRequest in the Project. |
commercetools_quotes_delete_quote_requests_by_key | Deletes a QuoteRequest in the Project. |
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. |
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. |
commercetools_quotes_delete_recurring_orders_by_id | Deletes a Recurring Order in the Project. |
commercetools_quotes_delete_recurring_orders_by_key | Deletes a Recurring Order in the Project. |
commercetools_quotes_delete_staged_quotes_by_id | Deletes a StagedQuote in the Project. |
commercetools_quotes_delete_staged_quotes_by_key | Deletes a StagedQuote in the Project. |
commercetools_quotes_get_by_id | Retrieves a Quote with the provided id. |
commercetools_quotes_get_by_key | Retrieves a Quote with the provided key. |
commercetools_quotes_get_quote_requests_by_id | Retrieves a QuoteRequest with the provided id. |
commercetools_quotes_get_quote_requests_by_key | Retrieves a QuoteRequest with the provided key. |
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. |
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. |
commercetools_quotes_get_recurring_orders_by_id | Retrieves a Recurring Order with the provided id. |
commercetools_quotes_get_recurring_orders_by_key | Retrieves a Recurring Order with the provided key. |
commercetools_quotes_get_staged_quotes_by_id | Retrieves a StagedQuote with the provided id. |
commercetools_quotes_get_staged_quotes_by_key | Retrieves a StagedQuote with the provided key. |
commercetools_quotes_list_quote_requests | Retrieves all QuoteRequests in the Project. |
commercetools_quotes_list_quotes | Retrieves all Quotes in the Project. |
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. |
commercetools_quotes_list_recurring_orders | Retrieves Recurring Orders in the Project. |
commercetools_quotes_list_staged_quotes | Retrieves all StagedQuotes in the Project. |
commercetools_quotes_update_quote_requests_by_id | Updates a QuoteRequest in the Project using one or more update actions. |
commercetools_quotes_update_quote_requests_by_key | Updates a QuoteRequest in the Project using one or more update actions. |
commercetools_quotes_update_quotes_by_id | Updates a Quote in the Project using one or more update actions. |
commercetools_quotes_update_quotes_by_key | Updates a Quote in the Project using one or more update actions. |
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. |
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. |
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. |
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. |
commercetools_quotes_update_staged_quotes_by_id | Updates a StagedQuote in the Project using one or more update actions. |
commercetools_quotes_update_staged_quotes_by_key | Updates a StagedQuote in the Project using one or more update actions. |
commercetools_quotes_create_quote_requests
Creates a QuoteRequest in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
cart | object | Yes | — | The cart value |
cartVersion | integer | Yes | — | Cart Version |
comment | string | No | — | The comment value |
custom | object | No | — | The custom value |
key | string | No | — | The key value |
purchaseOrderNumber | string | No | — | Purchase Order Number |
state | object | No | — | The state value |
commercetools_quotes_create_quotes
Creates a Quote in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
custom | object | No | — | The custom value |
key | string | No | — | The key value |
stagedQuote | object | Yes | — | Staged Quote |
stagedQuoteStateToSent | boolean | No | — | Staged Quote State To Sent |
stagedQuoteVersion | integer | Yes | — | Staged Quote Version |
state | object | No | — | The state value |
commercetools_quotes_create_recurrence_policies
Creates a Recurrence Policy in the Project. Themanage_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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
description | object | No | — | The description value |
key | string | Yes | — | The key value |
name | object | No | — | The name value |
schedule | object | Yes | — | The 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 toExpired, 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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
cart | object | Yes | — | The cart value |
cartVersion | integer | Yes | — | Cart Version |
custom | object | No | — | The custom value |
expiresAt | string | No | — | Expires At |
key | string | No | — | The key value |
startsAt | string | No | — | Starts At |
state | object | No | — | The state value |
commercetools_quotes_create_staged_quotes
Creates a StagedQuote in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
custom | object | No | — | The custom value |
key | string | No | — | The key value |
quoteRequest | object | Yes | — | Quote Request |
quoteRequestStateToAccepted | boolean | No | — | Quote Request State To Accepted |
quoteRequestVersion | integer | Yes | — | Quote Request Version |
state | object | No | — | The state value |
commercetools_quotes_delete_by_id
Deletes a Quote in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_delete_by_key
Deletes a Quote in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_delete_quote_requests_by_id
Deletes a QuoteRequest in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_delete_quote_requests_by_key
Deletes a QuoteRequest in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related 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. Themanage_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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related 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. Themanage_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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_delete_recurring_orders_by_id
Deletes a Recurring Order in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_delete_recurring_orders_by_key
Deletes a Recurring Order in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_delete_staged_quotes_by_id
Deletes a StagedQuote in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_delete_staged_quotes_by_key
Deletes a StagedQuote in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_by_id
Retrieves a Quote with the providedid.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_by_key
Retrieves a Quote with the providedkey.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_quote_requests_by_id
Retrieves a QuoteRequest with the providedid.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_quote_requests_by_key
Retrieves a QuoteRequest with the providedkey.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_recurrence_policies_by_id
Retrieves a Recurrence Policy with the providedid. 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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_recurrence_policies_by_key
Retrieves a Recurrence Policy with the providedkey. 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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_recurring_orders_by_id
Retrieves a Recurring Order with the providedid.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_recurring_orders_by_key
Retrieves a Recurring Order with the providedkey.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_staged_quotes_by_id
Retrieves a StagedQuote with the providedid.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_get_staged_quotes_by_key
Retrieves a StagedQuote with the providedkey.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_quotes_list_quote_requests
Retrieves all QuoteRequests in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_quotes_list_quotes
Retrieves all Quotes in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_quotes_list_recurrence_policies
Retrieves Recurrence Policies in the Project. Theview_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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_quotes_list_recurring_orders
Retrieves Recurring Orders in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_quotes_list_staged_quotes
Retrieves all StagedQuotes in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_quotes_update_quote_requests_by_id
Updates a QuoteRequest in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_quotes_update_quote_requests_by_key
Updates a QuoteRequest in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_quotes_update_quotes_by_id
Updates a Quote in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_quotes_update_quotes_by_key
Updates a Quote in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_quotes_update_recurrence_policies_by_id
Updates a Recurrence Policy using one or more update actions. Themanage_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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_quotes_update_recurrence_policies_by_key
Updates a Recurrence Policy using one or more update actions. Themanage_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:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_quotes_update_staged_quotes_by_id
Updates a StagedQuote in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_quotes_update_staged_quotes_by_key
Updates a StagedQuote in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |

