1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. SelfService
  5. Quotes

Interact with the quote

post

/ccstore/v1/selfservice/quotes/{id}/interact

Interacts with the CPQ Quote and get the quote data in the desired format without actually saving the changes.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : InteractQuoteRequest
Type: object
Show Source
Example:
{
    "criteria":{
        "childDefs":[
            {
                "name":"transactionLine",
                "queryDef":{
                    "totalResults":true,
                    "offset":0,
                    "limit":10,
                    "state":false,
                    "nodesExceptionList":[
                        2,
                        3
                    ],
                    "enableHierarchy":true,
                    "expandNodes":false
                }
            }
        ],
        "state":false
    },
    "delta":true
}
Nested Schema : criteria
Type: object
Show Source
Nested Schema : childDefs
Type: array
Show Source
Nested Schema : expandedDomains
Type: array
The list of expanded Domains.
Show Source
Nested Schema : fields
Type: array
The list of properties to be returned in the response
Show Source
Nested Schema : items
Type: object
Captures the query criteria for the child resource
Show Source
Nested Schema : queryDef
Type: object
Query definition for the current resource request.
Show Source
Nested Schema : fields
Type: array
List of field names that are to be returned
Show Source
Nested Schema : nodesExceptionList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Response containing the requested details
Body ()
Root Schema : InteractQuoteResponse
Example:
{
    "documents":{
        "_locked_by_user_login":null,
        "_s_soldToPartyName_t":null,
        "_reject_link":"",
        "_s_billTo_t_state":null,
        "_document_var_name":"transaction",
        "_customer_t_last_name":"Dilliard",
        "_customer_t_phone":null,
        "_customer_id":"1006",
        "_eSignatureAttributeSet_esig_file_attachment":{
            "fileName":null,
            "isFileSaved":false,
            "fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41691249/documents/41454591",
            "fileType":null,
            "fileID":null
        },
        "_customer_t_company_name":null,
        "_s_accountIntegrationResponse_t":null,
        "_s_billTo_t_city":null,
        "_s_isPublished_t":true,
        "_s_billTo_t_fax":null,
        "_customer_t_state":{
            "displayValue":"New York",
            "value":"New York"
        },
        "priceExpirationDate_t":null,
        "_s_orderDiscountAmount_t":null,
        "_s_customerStatus_t":{
            "displayValue":"Negotiation",
            "value":"negotiation"
        },
        "_s_billTo_t_phone":null,
        "_locked_time":null,
        "_s_billTo_t_zip":null,
        "createdDate_t":"2024-05-15",
        "_date_modified":"2024-05-15T06:36:19.000Z",
        "_s_billTo_t_address":null,
        "_customer_t_address":"70 Euclid Ave #722",
        "cC_ProviderNote_c":null,
        "_tax_isTaxInclusive_t":false,
        "_last_document_number":2,
        "cC_OrderId_c":null,
        "_customer_t_city":"Bohemia",
        "_esigTest_c_esig_date_modified":null,
        "_approve_link":"",
        "_esigTest_c_esig_status":{
            "displayValue":"Not Sent",
            "value":"Not Sent"
        },
        "_eSignatureAttributeSet_esig_date_modified":null,
        "_tax_isTaxPresent_t":false,
        "cC_ExpirationDate_c":null,
        "transactionDescription_t":null,
        "_s_signedProposalDocument_t":{
            "fileName":null,
            "isFileSaved":false,
            "fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41691249/documents/41454591",
            "fileType":null,
            "fileID":null
        },
        "_date_added":"2024-05-15T06:32:45.000Z",
        "_s_contactPartyNumber_t":null,
        "_customer_t_address_2":"Suffolk",
        "transactionLine":{
            "totalResults":1,
            "offset":0,
            "limit":10,
            "count":1,
            "hasMore":false,
            "items":[
                {
                    "testAttr_c":null,
                    "_shipTo_l_country":null,
                    "_shipping_shippingServiceLevel_l":null,
                    "_tax_totalContractAmountRollup_l":null,
                    "_document_var_name":"transactionLine",
                    "_s_unitProratedOrderDiscount_l":null,
                    "_s_totalProratedOrderDiscount_l":null,
                    "_tax_totalAmountRollup_l":null,
                    "_shipTo_l_zip":null,
                    "_tax_totalAmount_l":null,
                    "_tax_taxPrice_l":null,
                    "_s_inventoryOrganisationId_l":null,
                    "_shipTo_l_fax":null,
                    "includedInBasePrice":null,
                    "_parent_line_item":null,
                    "_date_modified":"2024-05-15T06:32:46.000Z",
                    "_shipTo_l_address":null,
                    "cC_CatalogRefId_c":null,
                    "_s_externalItemId_l":null,
                    "documentNumber_l":"2",
                    "_is_part_pricing_rule_price":true,
                    "_line_bom_model_path":null,
                    "_tax_totalPrice_l":null,
                    "_model_id":null,
                    "_date_added":"2024-05-15T06:32:45.000Z",
                    "_shipTo_l_phone":null,
                    "_parent_doc_number":null,
                    "_is_line_item_mandatory":false,
                    "_model_product_line_id":null,
                    "_last_modified_date":"2024-05-15 06:32:46",
                    "_shipTo_l_city":null,
                    "_shipping_shippingInstructions_l":null,
                    "_tax_totalPriceRollup_l":null,
                    "_reconfiguration_date":"1970-01-01 00:00:00",
                    "_id":41610089,
                    "_shipTo_l_address_2":null,
                    "_pp_id":41525025,
                    "_document_number":2,
                    "_tax_totalPriceMinusTax_l":null,
                    "_is_bom_price":false,
                    "_line_item_comment":null,
                    "_shipTo_l_email":null,
                    "_line_bom_sequence_index":null,
                    "_shipTo_l_first_name":null,
                    "_sequence_number":1,
                    "_step_var_name":"pending_process",
                    "_line_bom_display_name":null,
                    "cC_CommerceItemId_c":null,
                    "_part_supplier_company_id":"4118171",
                    "_tax_totalAmountMinusTax_l":null,
                    "_original_document_number":"-1",
                    "_is_recommended_price":false,
                    "cC_ProductId_c":null,
                    "_shipTo_l_company_name_2":null,
                    "test_custom_c":null,
                    "_line_item_spare_rule_var_name":null,
                    "_tax_taxRollup_l":null,
                    "_shipping_shippingGroupId_l":null,
                    "_part_id":"38746515",
                    "_shipTo_l_state":null,
                    "_shipTo_l_last_name":null,
                    "_transaction_currency_pref":{
                        "id":5190368,
                        "currencyCode":"USD"
                    },
                    "_shipTo_l_company_name":null,
                    "_price_book_var_name":"_default_price_book",
                    "_model_supplier_company_id":null,
                    "_tax_calculation_info":null,
                    "_model_segment_id":null,
                    "_bs_id":41610087,
                    "_pp_name":"Self Service User",
                    "_line_bom_condition_index":null
                }
            ]
        },
        "contactName_t":null,
        "transactionName_t":"05/15 ",
        "_id":41610087,
        "contactLastName_t":null,
        "_s_billTo_t_address_2":null,
        "_pp_id":41525025,
        "_document_number":"1",
        "cC_LineItem_Data_c":null,
        "fileAttachment_t":{
            "fileName":null,
            "isFileSaved":false,
            "fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41691249/documents/41454591",
            "fileType":null,
            "fileID":null
        },
        "_esigTest_c_esig_recipients":null,
        "cC_SiteId_c":null,
        "owner_t":"Albert M",
        "_process_var_name":"oraclecpqo",
        "_s_billTo_t_email":null,
        "_locked_by_user_first_name":null,
        "contactFirstName_t":null,
        "_s_billTo_t_country":null,
        "_customer_t_country":null,
        "createdBy_t":"Albert M",
        "_step_var_name":"pending_process",
        "_customer_t_zip":null,
        "bs_id":"41610087",
        "_lock_status":false,
        "_customer_t_fax":null,
        "currency_t":{
            "displayValue":"USD",
            "value":"USD"
        },
        "_submitted_by_submit_t":"",
        "_s_assignedTo_t":{
            "displayValue":"Seller",
            "value":"SELLER"
        },
        "_customer_t_email":"kim1@example.com",
        "_esigTest_c_esig_envelope_id":null,
        "_s_transactionSource_t":{
            "displayValue":"Seller Initiated",
            "value":"sellerInitiated"
        },
        "_s_billTo_t_first_name":null,
        "_eSignatureAttributeSet_esig_status":{
            "displayValue":"Not Sent",
            "value":"Not Sent"
        },
        "_locked_by_user_last_name":null,
        "_s_billTo_t_last_name":null,
        "transactionID_t":"CPQ-12",
        "_customer_t_company_name_2":null,
        "_buyer_company_name":"cpqqa230",
        "_s_hostCompanyFullName_t":"cpqqa230",
        "_s_billTo_t_company_name":null,
        "_price_book_var_name":"_default_price_book",
        "_date_tx_modified":"2024-05-15T06:36:19.000Z",
        "_supplier_company_name":"cpqqa230",
        "_locked_by_user":-1,
        "_s_billToCustomerAccountID_t":null,
        "_s_billToCustomerAccountName_t":null,
        "_customer_t_first_name":"Leota",
        "_s_billTo_t_company_name_2":null,
        "_currency_pref":{
            "id":5190368,
            "currencyCode":"USD"
        },
        "contactEmailAddress_t":null,
        "_s_isDocumentSigned_t":false,
        "_tax_taxAmount_t":null,
        "_eSignatureAttributeSet_esig_recipients":null,
        "_pp_name":"Self Service User"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41610087/interact"
        }
    ]
}

400 Response

Bad query params in the request
Body ()
Root Schema : Error
Type: object
Show Source
Back to Top