> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # commercetools-quotes > commercetools Quotes - manage quotes, quote requests, staged quotes, and recurring orders **Server path:** `/commercetools-quotes` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`commercetools_quotes_create_quote_requests`](#commercetools_quotes_create_quote_requests) | Creates a QuoteRequest in the Project. | | [`commercetools_quotes_create_quotes`](#commercetools_quotes_create_quotes) | Creates a Quote in the Project. | | [`commercetools_quotes_create_recurrence_policies`](#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`](#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`](#commercetools_quotes_create_staged_quotes) | Creates a StagedQuote in the Project. | | [`commercetools_quotes_delete_by_id`](#commercetools_quotes_delete_by_id) | Deletes a Quote in the Project. | | [`commercetools_quotes_delete_by_key`](#commercetools_quotes_delete_by_key) | Deletes a Quote in the Project. | | [`commercetools_quotes_delete_quote_requests_by_id`](#commercetools_quotes_delete_quote_requests_by_id) | Deletes a QuoteRequest in the Project. | | [`commercetools_quotes_delete_quote_requests_by_key`](#commercetools_quotes_delete_quote_requests_by_key) | Deletes a QuoteRequest in the Project. | | [`commercetools_quotes_delete_recurrence_policies_by_id`](#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`](#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`](#commercetools_quotes_delete_recurring_orders_by_id) | Deletes a Recurring Order in the Project. | | [`commercetools_quotes_delete_recurring_orders_by_key`](#commercetools_quotes_delete_recurring_orders_by_key) | Deletes a Recurring Order in the Project. | | [`commercetools_quotes_delete_staged_quotes_by_id`](#commercetools_quotes_delete_staged_quotes_by_id) | Deletes a StagedQuote in the Project. | | [`commercetools_quotes_delete_staged_quotes_by_key`](#commercetools_quotes_delete_staged_quotes_by_key) | Deletes a StagedQuote in the Project. | | [`commercetools_quotes_get_by_id`](#commercetools_quotes_get_by_id) | Retrieves a Quote with the provided `id`. | | [`commercetools_quotes_get_by_key`](#commercetools_quotes_get_by_key) | Retrieves a Quote with the provided `key`. | | [`commercetools_quotes_get_quote_requests_by_id`](#commercetools_quotes_get_quote_requests_by_id) | Retrieves a QuoteRequest with the provided `id`. | | [`commercetools_quotes_get_quote_requests_by_key`](#commercetools_quotes_get_quote_requests_by_key) | Retrieves a QuoteRequest with the provided `key`. | | [`commercetools_quotes_get_recurrence_policies_by_id`](#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`](#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`](#commercetools_quotes_get_recurring_orders_by_id) | Retrieves a Recurring Order with the provided `id`. | | [`commercetools_quotes_get_recurring_orders_by_key`](#commercetools_quotes_get_recurring_orders_by_key) | Retrieves a Recurring Order with the provided `key`. | | [`commercetools_quotes_get_staged_quotes_by_id`](#commercetools_quotes_get_staged_quotes_by_id) | Retrieves a StagedQuote with the provided `id`. | | [`commercetools_quotes_get_staged_quotes_by_key`](#commercetools_quotes_get_staged_quotes_by_key) | Retrieves a StagedQuote with the provided `key`. | | [`commercetools_quotes_list_quote_requests`](#commercetools_quotes_list_quote_requests) | Retrieves all QuoteRequests in the Project. | | [`commercetools_quotes_list_quotes`](#commercetools_quotes_list_quotes) | Retrieves all Quotes in the Project. | | [`commercetools_quotes_list_recurrence_policies`](#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`](#commercetools_quotes_list_recurring_orders) | Retrieves Recurring Orders in the Project. | | [`commercetools_quotes_list_staged_quotes`](#commercetools_quotes_list_staged_quotes) | Retrieves all StagedQuotes in the Project. | | [`commercetools_quotes_update_quote_requests_by_id`](#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`](#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`](#commercetools_quotes_update_quotes_by_id) | Updates a Quote in the Project using one or more update actions. | | [`commercetools_quotes_update_quotes_by_key`](#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`](#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`](#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`](#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`](#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`](#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`](#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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "cart": { "description": "The cart value" }, "cartVersion": { "type": "integer", "description": "Cart Version" }, "comment": { "type": "string", "description": "The comment value" }, "custom": { "type": "object", "description": "The custom value", "properties": { "type": { "description": "The type value" }, "fields": { "type": "object", "description": "The fields value" } }, "required": [ "type" ] }, "key": { "type": "string", "description": "The key value" }, "purchaseOrderNumber": { "type": "string", "description": "Purchase Order Number" }, "state": { "description": "The state value" } }, "required": [ "PCID", "cart", "cartVersion" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "custom": { "type": "object", "description": "The custom value", "properties": { "type": { "description": "The type value" }, "fields": { "type": "object", "description": "The fields value" } }, "required": [ "type" ] }, "key": { "type": "string", "description": "The key value" }, "stagedQuote": { "description": "Staged Quote" }, "stagedQuoteStateToSent": { "type": "boolean", "description": "Staged Quote State To Sent" }, "stagedQuoteVersion": { "type": "integer", "description": "Staged Quote Version" }, "state": { "description": "The state value" } }, "required": [ "PCID", "stagedQuote", "stagedQuoteVersion" ] } ``` *** ## 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:** | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "description": { "type": "object", "description": "The description value" }, "key": { "type": "string", "description": "The key value" }, "name": { "type": "object", "description": "The name value" }, "schedule": { "type": "object", "description": "The schedule value", "properties": { "type": { "type": "string", "description": "The type value" } }, "required": [ "type" ] } }, "required": [ "PCID", "key", "schedule" ] } ``` *** ## 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:** | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "cart": { "description": "The cart value" }, "cartVersion": { "type": "integer", "description": "Cart Version" }, "custom": { "type": "object", "description": "The custom value", "properties": { "type": { "description": "The type value" }, "fields": { "type": "object", "description": "The fields value" } }, "required": [ "type" ] }, "expiresAt": { "type": "string", "description": "Expires At" }, "key": { "type": "string", "description": "The key value" }, "startsAt": { "type": "string", "description": "Starts At" }, "state": { "description": "The state value" } }, "required": [ "PCID", "cart", "cartVersion" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "custom": { "type": "object", "description": "The custom value", "properties": { "type": { "description": "The type value" }, "fields": { "type": "object", "description": "The fields value" } }, "required": [ "type" ] }, "key": { "type": "string", "description": "The key value" }, "quoteRequest": { "description": "Quote Request" }, "quoteRequestStateToAccepted": { "type": "boolean", "description": "Quote Request State To Accepted" }, "quoteRequestVersion": { "type": "integer", "description": "Quote Request Version" }, "state": { "description": "The state value" } }, "required": [ "PCID", "quoteRequest", "quoteRequestVersion" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key", "version" ] } ``` *** ## 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:** | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID", "version" ] } ``` *** ## 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:** | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "dataErasure": { "type": "boolean", "description": "Data Erasure" }, "version": { "type": "integer", "description": "The version value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key", "version" ] } ``` *** ## commercetools\_quotes\_get\_by\_id Retrieves a Quote with the provided `id`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `ID` | string | Yes | — | The id value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID" ] } ``` *** ## commercetools\_quotes\_get\_by\_key Retrieves a Quote with the provided `key`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `key` | string | Yes | — | The key value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key" ] } ``` *** ## commercetools\_quotes\_get\_quote\_requests\_by\_id Retrieves a QuoteRequest with the provided `id`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `ID` | string | Yes | — | The id value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID" ] } ``` *** ## commercetools\_quotes\_get\_quote\_requests\_by\_key Retrieves a QuoteRequest with the provided `key`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `key` | string | Yes | — | The key value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "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. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `ID` | string | Yes | — | The id value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `key` | string | Yes | — | The key value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key" ] } ``` *** ## commercetools\_quotes\_get\_recurring\_orders\_by\_id Retrieves a Recurring Order with the provided `id`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `ID` | string | Yes | — | The id value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID" ] } ``` *** ## commercetools\_quotes\_get\_recurring\_orders\_by\_key Retrieves a Recurring Order with the provided `key`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `key` | string | Yes | — | The key value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key" ] } ``` *** ## commercetools\_quotes\_get\_staged\_quotes\_by\_id Retrieves a StagedQuote with the provided `id`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `ID` | string | Yes | — | The id value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "ID" ] } ``` *** ## commercetools\_quotes\_get\_staged\_quotes\_by\_key Retrieves a StagedQuote with the provided `key`. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------- | | `key` | string | Yes | — | The key value | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "key" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "Sort order for results" }, "limit": { "type": "integer", "description": "Maximum number of results to return" }, "offset": { "type": "integer", "description": "The offset value" }, "withTotal": { "type": "boolean", "description": "With Total" }, "where": { "type": "array", "items": { "type": "string" }, "description": "The where value" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "Sort order for results" }, "limit": { "type": "integer", "description": "Maximum number of results to return" }, "offset": { "type": "integer", "description": "The offset value" }, "withTotal": { "type": "boolean", "description": "With Total" }, "where": { "type": "array", "items": { "type": "string" }, "description": "The where value" } }, "required": [ "PCID" ] } ``` *** ## 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:** | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "Sort order for results" }, "limit": { "type": "integer", "description": "Maximum number of results to return" }, "offset": { "type": "integer", "description": "The offset value" }, "withTotal": { "type": "boolean", "description": "With Total" }, "where": { "type": "array", "items": { "type": "string" }, "description": "The where value" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "Sort order for results" }, "limit": { "type": "integer", "description": "Maximum number of results to return" }, "offset": { "type": "integer", "description": "The offset value" }, "withTotal": { "type": "boolean", "description": "With Total" }, "where": { "type": "array", "items": { "type": "string" }, "description": "The where value" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "Sort order for results" }, "limit": { "type": "integer", "description": "Maximum number of results to return" }, "offset": { "type": "integer", "description": "The offset value" }, "withTotal": { "type": "boolean", "description": "With Total" }, "where": { "type": "array", "items": { "type": "string" }, "description": "The where value" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "ID", "actions", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "key", "actions", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "ID", "actions", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "key", "actions", "version" ] } ``` *** ## 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:** | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "ID", "actions", "version" ] } ``` *** ## 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:** | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "key", "actions", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "ID", "actions", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "key", "actions", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ID": { "type": "string", "description": "The id value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "ID", "actions", "version" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "The key value" }, "expand": { "type": "array", "items": { "type": "string" }, "description": "Related resources to expand inline" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The action value" } }, "required": [ "action" ] }, "description": "The actions value" }, "version": { "type": "integer", "description": "The version value" } }, "required": [ "PCID", "key", "actions", "version" ] } ```