Generates the quote proposal document
post
/ccstore/v1/selfservice/quotes/{id}/generateProposal
Generates the proposal document
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
ID of quote.
Root Schema : GenerateProposalRequest
Type:
Show Source
object
-
documents:
object documents
-
processAsync:
boolean
Indicates if the request is to be processed in async manner
Example:
{
"processAsync":true,
"documents":{
"comments":"Need proposal document",
"commentType":"comment"
}
}
Nested Schema : documents
Type:
Show Source
object
-
comments:
string
Comments from the document requestor
-
commentType:
string
Type of comment: systemActivity or comment
Response
Supported Media Types
- application/json
200 Response
Response containing the quote proposal document details
Root Schema : GenerateProposalResponse
Example:
{
"revisionId":"21,0",
"generatedProposalAttachmentForMerge":[
{
"name":"GENERATED PROPOSAL",
"id":-2
}
],
"documents":{
"_s_soldToPartyName_t":null,
"_s_billTo_t_state":null,
"_document_var_name":"transaction",
"_customer_t_phone":"631-748-6479",
"_customer_id":"12747",
"_eSignatureAttributeSet_esig_file_attachment":{
"fileName":null,
"isFileSaved":false,
"fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41611093/documents/41454591",
"fileType":null,
"fileID":null
},
"_s_billTo_t_city":null,
"_s_billTo_t_fax":null,
"_customer_t_state":{
"displayValue":"NY",
"value":"NY"
},
"_s_orderDiscountAmount_t":null,
"_s_billTo_t_phone":null,
"_s_billTo_t_zip":null,
"createdDate_t":"2024-05-24",
"_date_modified":"2024-06-11T13:24:38.000Z",
"_customer_t_address":"70 Euclid Ave #722",
"_tax_isTaxInclusive_t":false,
"transactionDescription_t":null,
"_s_signedProposalDocument_t":{
"fileName":null,
"isFileSaved":false,
"fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41611093/documents/41454591",
"fileType":null,
"fileID":null
},
"_date_added":"2024-05-24T10:28:04.000Z",
"_s_contactPartyNumber_t":null,
"contactName_t":"Michael Keaton",
"_s_billTo_t_address_2":null,
"fileAttachment_t":{
"fileName":"Document.pdf",
"isFileSaved":true,
"fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41611093/documents/41454591",
"fileType":"application/pdf",
"fileID":"41618810"
},
"cC_SiteId_c":"siteUS",
"_process_var_name":"oraclecpqo",
"_locked_by_user_first_name":null,
"_s_billTo_t_country":null,
"_customer_t_country":{
"displayValue":"US",
"value":"US"
},
"createdBy_t":"Albert M",
"bs_id":"41611093",
"_submitted_by_submit_t":"",
"_s_assignedTo_t":{
"displayValue":"Seller",
"value":"SELLER"
},
"_customer_t_email":"superuser@example.com",
"_locked_by_user_last_name":null,
"_s_billTo_t_last_name":null,
"transactionID_t":"CPQ-48",
"_buyer_company_name":"cpqqa230",
"_s_hostCompanyFullName_t":"cpqqa230",
"_s_billTo_t_company_name":null,
"_date_tx_modified":"2024-06-11T13:24:38.000Z",
"_s_billToCustomerAccountName_t":null,
"_eSignatureAttributeSet_esig_recipients":null,
"_locked_by_user_login":null,
"_reject_link":"",
"_customer_t_last_name":"Keaton",
"_customer_t_company_name":"National Discount Auto Parts",
"_s_accountIntegrationResponse_t":null,
"_s_isPublished_t":true,
"priceExpirationDate_t":null,
"_s_customerStatus_t":{
"displayValue":"Solution Discovery",
"value":"solutionDiscovery"
},
"_locked_time":null,
"proposalDocument":{
"name":"Document.pdf",
"location":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/42253990/documents/41454591",
"id":"42253071",
"type":"application/pdf"
},
"_s_billTo_t_address":null,
"cC_ProviderNote_c":null,
"sampleCustomer_c":null,
"_last_document_number":2,
"cC_OrderId_c":"o40414",
"_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,
"_customer_t_address_2":"Suffolk",
"transactionLine":{
"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-24T10:28:04.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-24T10:28:04.000Z",
"_shipTo_l_phone":null,
"_parent_doc_number":null,
"_is_line_item_mandatory":false,
"_model_product_line_id":null,
"_last_modified_date":"2024-05-24 10:28:04",
"_shipTo_l_city":null,
"_shipping_shippingInstructions_l":null,
"_tax_totalPriceRollup_l":null,
"_reconfiguration_date":"1970-01-01 00:00:00",
"_id":41611095,
"_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":41611093,
"_pp_name":"Self Service User",
"_line_bom_condition_index":null
}
]
},
"transactionName_t":"o40414",
"_s_skipSellerReview_t":null,
"_id":41611093,
"contactLastName_t":"Keaton",
"_pp_id":41525025,
"_document_number":"1",
"cC_LineItem_Data_c":null,
"_esigTest_c_esig_recipients":null,
"owner_t":"Albert M",
"_s_billTo_t_email":null,
"contactFirstName_t":"Michael",
"_step_var_name":"pending_process",
"_customer_t_zip":"11716",
"_lock_status":false,
"_customer_t_fax":null,
"currency_t":{
"displayValue":"USD",
"value":"USD"
},
"_esigTest_c_esig_envelope_id":null,
"_s_transactionSource_t":{
"displayValue":"Buyer Initiated",
"value":"buyerInitiated"
},
"_s_billTo_t_first_name":null,
"_eSignatureAttributeSet_esig_status":{
"displayValue":"Not Sent",
"value":"Not Sent"
},
"_customer_t_company_name_2":null,
"_price_book_var_name":"_default_price_book",
"_supplier_company_name":"cpqqa230",
"_locked_by_user":-1,
"_s_billToCustomerAccountID_t":null,
"_customer_t_first_name":"Michael",
"_s_billTo_t_company_name_2":null,
"_currency_pref":{
"id":5190368,
"currencyCode":"USD"
},
"contactEmailAddress_t":"superuser@example.com",
"_s_isDocumentSigned_t":false,
"_tax_taxAmount_t":null,
"_pp_name":"Self Service User"
},
"xslView":"DocumentTest(Printer Friendly/History)",
"availableAttachmentsForMerge":[
{
"name":"Document.pdf (Transaction - File Attachment)",
"id":41618810
}
],
"warnings":{
},
"langAttributeValue":-1,
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/41611093/generateProposal"
}
],
"fileAttachmentAttribute":"File Attachment"
}
202 Response
Details of the generate proposal async request accepted
Root Schema : GenerateProposalAsyncAcceptResponse
Type:
Show Source
object
-
message:
string
Details of the submitted request
-
queuedActionId:
string
Reference Id for the submitted request
Example:
{
"queuedActionId":"msg-1101",
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/37719419/generateProposal"
}
],
"message":"Received your request for generateProposal. It can be tracked with id msg-1101."
}
400 Response
Bad params in the request body
Root Schema : Error
Type:
Show Source
object
-
message:
string
The error message
-
status:
string
The Error code
409 Response
Details of generate proposal request rejected.
Root Schema : GenerateProposalAsyncRejectResponse
Type:
Show Source
object
-
message:
string
Details of the rejected request
Example:
{
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/37719419/generateProposal"
}
],
"message":"A request for generateProposal is already in process for id 37719419."
}