REST API for Oracle Commerce Cloud

Retrieves the quote detail based on quoteId

get

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

If the profile is not logged in or is anonymous then the endpoint will fail. The user should be granted required access rights based on which the this api will return the quote detail

Request

Supported Media Types

application/json

Path Parameters

id(required): string

ID of quote.

Query Parameters

fields: string

This controls which fields are returned in the response body. For example, to include the totalAnnualValue_t and totalContractValue_t for each quote in the list, you can send fields=totalAnnualValue_t,totalContractValue_t.

Response

Supported Media Types

application/json

200 Response

Response containing the quote detail

Root Schema : GetQuoteResponse

Example:

{
    "totalOneTimeListAmount_t":{
        "currency":"USD",
        "value":7
    },
    "_s_soldToPartyName_t":null,
    "_s_billTo_t_state":null,
    "_document_var_name":"transaction",
    "_customer_t_phone":null,
    "_customer_id":"12747",
    "transactionTotalDiscountPercent_t":0,
    "_s_billTo_t_city":null,
    "_s_billTo_t_fax":null,
    "_customer_t_state":null,
    "totalContractValue_t":{
        "currency":"USD",
        "value":7
    },
    "_s_orderDiscountAmount_t":null,
    "_s_billTo_t_phone":null,
    "contractStartDate_t":"2024-07-12",
    "_s_billTo_t_zip":null,
    "totalMonthlyUsageRev_t":{
        "currency":"USD",
        "value":0
    },
    "createdDate_t":"2024-07-12",
    "_date_modified":"2024-07-15T10:52:13.000Z",
    "_customer_t_address":null,
    "contactType_t":null,
    "_tax_isTaxInclusive_t":false,
    "transactionDescription_t":null,
    "totalMonthlyCostAmount_t":{
        "currency":"USD",
        "value":0
    },
    "_s_signedProposalDocument_t":{
        "fileName":null,
        "isFileSaved":false,
        "fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/42253990/documents/41454591",
        "fileType":null,
        "fileID":null
    },
    "_date_added":"2024-07-12T15:51:24.000Z",
    "_s_contactPartyNumber_t":"CDRM_965910",
    "totalAnnualCostAmount_t":{
        "currency":"USD",
        "value":0
    },
    "contactName_t":"Sundeep Challa",
    "contractEndDate_t":"2025-07-11",
    "_s_billTo_t_address_2":null,
    "totalUsageRevenue_t":{
        "currency":"USD",
        "value":0
    },
    "fileAttachment_t":{
        "fileName":"Document.pdf",
        "isFileSaved":true,
        "fileLocation":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/42253990/documents/41454591",
        "fileType":"application/pdf",
        "fileID":"42253071"
    },
    "cC_SiteId_c":"siteUS",
    "_process_var_name":"oraclecpqo",
    "_locked_by_user_first_name":null,
    "_s_billTo_t_country":null,
    "_customer_t_country":null,
    "createdBy_t":"Albert M",
    "contractedPeriods_t":1,
    "totalOneTimeNetAmount_t":{
        "currency":"USD",
        "value":7
    },
    "bs_id":"42253990",
    "contactMiddleName_t":null,
    "_submitted_by_submit_t":"",
    "_s_assignedTo_t":{
        "displayValue":"Buyer",
        "value":"BUYER"
    },
    "_stage":{
        "displayValue":"Quote",
        "value":"QUOTE"
    },
    "_s_isLatestProposal_t":true,
    "_customer_t_email":"sundeep.challa@oracle.com",
    "_locked_by_user_last_name":null,
    "_s_billTo_t_last_name":null,
    "transactionID_t":"CPQ-308",
    "_buyer_company_name":"cpqqa230",
    "totalMonthlyDiscount_t":{
        "currency":"USD",
        "value":0
    },
    "_s_hostCompanyFullName_t":"cpqqa230",
    "_s_billTo_t_company_name":null,
    "_date_tx_modified":"2024-07-15T10:52:13.000Z",
    "_freezePrice":false,
    "_s_billToCustomerAccountName_t":null,
    "totalContractDiscount_t":{
        "currency":"USD",
        "value":0
    },
    "orderPlacedBy_t":null,
    "totalOneTimeCostAmount_t":{
        "currency":"USD",
        "value":0
    },
    "_locked_by_user_login":null,
    "_reject_link":"",
    "_customer_t_last_name":"Challa",
    "_customer_t_company_name":"Miller Manufacturing",
    "_s_accountIntegrationResponse_t":null,
    "totalAnnualValue_t":{
        "currency":"USD",
        "value":0
    },
    "totalContractCostAmount_t":{
        "currency":"USD",
        "value":0
    },
    "_s_isPublished_t":true,
    "priceExpirationDate_t":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/selfservice/quotes/42253990"
        }
    ],
    "_s_customerStatus_t":{
        "displayValue":"Acceptance",
        "value":"acceptance"
    },
    "_locked_time":null,
    "_transaction_total":null,
    "annualContractListValue_t":{
        "currency":"USD",
        "value":0
    },
    "priceScore_t":1,
    "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,
    "totalRecurRevenue_t":{
        "currency":"USD",
        "value":0
    },
    "sampleCustomer_c":null,
    "_last_document_number":2,
    "cC_OrderId_c":"o30504",
    "_customer_t_city":null,
    "_esigTest_c_esig_date_modified":null,
    "_approve_link":"",
    "_esigTest_c_esig_status":{
        "displayValue":"Not Sent",
        "value":"Not Sent"
    },
    "_tax_isTaxPresent_t":false,
    "cC_ExpirationDate_c":null,
    "salesRepCheckoutEnabled":false,
    "_customer_t_address_2":null,
    "transactionName_t":null,
    "_s_skipSellerReview_t":true,
    "_id":42253990,
    "contactLastName_t":"Challa",
    "_pp_id":41651015,
    "_document_number":"1",
    "cC_LineItem_Data_c":null,
    "_esigTest_c_esig_recipients":null,
    "owner_t":"Albert M",
    "_s_billTo_t_email":null,
    "contactFirstName_t":"Sundeep",
    "_step_var_name":"awaitingCustomerAcceptance",
    "_customer_t_zip":null,
    "_lock_status":false,
    "_customer_t_fax":null,
    "currency_t":{
        "displayValue":"USD",
        "value":"USD"
    },
    "totalMonthlyListAmount_t":{
        "currency":"USD",
        "value":0
    },
    "_s_externalOrderId_t":null,
    "_esigTest_c_esig_envelope_id":null,
    "_s_transactionSource_t":{
        "displayValue":"Buyer Initiated",
        "value":"buyerInitiated"
    },
    "totalContractListValue_t":{
        "currency":"USD",
        "value":7
    },
    "_s_billTo_t_first_name":null,
    "TotalAnnualDiscount_t":{
        "currency":"USD",
        "value":0
    },
    "_customer_t_company_name_2":null,
    "eSignEnabled":false,
    "_price_book_var_name":"_default_price_book",
    "_supplier_company_name":"cpqqa230",
    "_locked_by_user":-1,
    "_s_billToCustomerAccountID_t":null,
    "_customer_t_first_name":"Sundeep",
    "_s_billTo_t_company_name_2":null,
    "_currency_pref":{
        "id":5190368,
        "currencyCode":"USD"
    },
    "contactEmailAddress_t":"sundeep.challa@oracle.com",
    "_s_isDocumentSigned_t":false,
    "_tax_taxAmount_t":null,
    "totalOneTimeDiscount_t":{
        "currency":"USD",
        "value":0
    },
    "_pp_name":"Self Service User",
    "selfCheckoutEnabled":true,
    "totalMonthlyNetAmount_t":{
        "currency":"USD",
        "value":0
    }
}

400 Response

Bad query params in the request

Root Schema : Error

Type: object

Show Source

message: string

The error message
status: string

The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}