home

general

Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)CPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration ManagerRelease NotesGeneral
search
search
Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)CPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration ManagerRelease NotesGeneral

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

search

general

chevron_left

general Contents

close

  • Features by Release

  • Conga Upgrade Program

  • chevron_right

    System Requirements and Supported Platforms Matrix

  • Managed Packages Dependency Matrix

  • Conga Applications in Salesforce Lightning

  • Salesforce Multi-Factor Authentication Support for Conga Commerce

  • chevron_right

    Conga Product Glossary

  • chevron_right

    Conga Upgrade Assistant

  • chevron_right

    Product Retirement Schedule

  • expand_more

    Developer Center

    • chevron_right

      Approvals for Salesforce REST APIs

    • chevron_right

      Billing for Salesforce REST APIs

    • chevron_right

      CLM for Salesforce REST APIs

    • chevron_right

      CPQ for Salesforce REST APIs

    • expand_more

      Digital Commerce for Salesforce REST APIs

      • expand_more

        CPQ REST API Version 4

        • chevron_right

          Authentication

        • chevron_right

          Storefront

        • chevron_right

          Account

        • chevron_right

          PriceList

        • chevron_right

          Catalog

        • chevron_right

          Carts

        • chevron_right

          Cart Items

        • expand_more

          Favorites

          • Create Favorites

            post

          • Update favorites

            put

          • Delete Favorites

            post

          • Add Favorite

            post
        • chevron_right

          Generic

        • chevron_right

          Order

        • chevron_right

          Quote

        • chevron_right

          Assets

        • chevron_right

          Collaboration Request

        • chevron_right

          User Views

      • chevron_right

        CPQ REST API Version 5

    • chevron_right

      Discovery AI for Salesforce REST APIs

    • chevron_right

      Orchestrate REST APIs

    • chevron_right

      Partner Commerce for Salesforce REST APIs

    • chevron_right

      TurboEngines REST APIs

    list_altShow Contents

    chevron_left

    General

    Favorites

    chevron_right
    download

    Add Favorite

    post
    /favorites/{favoriteId}/items

    Adds the selected products or lineitms to the favorite configuration.

    Request

    Security: Basic Auth

    Path Parameters

    favoriteId
    string
    required

    The reference Id of the favorite.

    Example:
    a3e79000000WYtUAAW

    Headers

    x-account
    string

    The account value from the header is taken as default account if passed as query parameter.

    Example:
    0011900000hnGsr
    Content-Type
    string
    required

    Content type of the request body.

    Example:
    application/json
    x-storefront
    string
    required

    The name of the storefront used for the request.

    Example:
    ECommerce

    Body

    Request body of Add Favorite.

    Example 1: Single product record or an array of products (if multiple).

    Example 2: List of lineNumbers associated with the lineitems selected to add as favorites.

    array of:

    Responses

    200

    OK

    Body

    responses
    /
    200
    Rules
    array[object]
    required
    ActionProductIds
    string
    TriggeringProductIds
    string
    SuggestedProductIds
    string
    IsTargetOption
    boolean
    pending
    boolean
    ConstraintRuleActionId
    string
    ConfigurationId
    string
    Message
    string
    Id
    string
    Name
    string
    LineItems
    array[object]
    required
    Product
    object
    AttributeValue
    object
    LineSequence
    integer
    LineType
    string
    LineStatus
    string
    LineNumber
    integer
    ItemSequence
    integer
    Quantity
    integer
    ProductId
    string
    PrimaryLineNumber
    integer
    Name
    string
    IsPrimaryLine
    boolean
    Id
    string
    Auth
    Username
    :
    Password
    :
    Parameters
    :
    :
    :
    :
    Body
    1
    {
    2
      "ProductId": "01t4R00000J5R6i",
    3
      "Quantity": 1
    4
    }
    curl --request POST \
      --url https://documentation.conga.com/favorites/favoriteId/items \
      --header 'Accept: application/json' \
      --header 'Authorization: Basic 123' \
      --header 'Content-Type: application/json' \
      --header 'x-account: ' \
      --header 'x-storefront: ' \
      --data '{
      "ProductId": "01t4R00000J5R6i",
      "Quantity": 1
    }'
    Response Example
    1
    {
    2
      "title": "success",
    3
      "status": 200,
    4
      "data": [
    5
        {
    6
          "Product_Family": "Hardware",
    7
          "SellingUom": "Each",
    8
          "Demo_Renewal_flag": "No",
    9
          "APTS_Local_Bundle_Component_Flag": false,
    10
          "ProductVersion": 1,
    11
          "OptionSequence": 0,
    12
          "NetUnitPrice": 950,
    13
          "LineSequence": 1,
    14
          "IsOptional": false,
    15
          "IsHidden": false,
    16
          "HideCopyAction": false,
    17
          "HasIncentives": false,
    18
          "DeltaQuantity": 1,
    19
          "DeltaPrice": 950,
    20
          "AutoRenew": false,
    21
          "Taxable": false,
    22
          "TaxInclusive": false,
    23
          "IsReadOnly": false,
    24
          "HideInvoiceDisplay": false,
    25
          "BillToAccountId": "0011900000hnGsrAAE",
    26
          "Operating_Expense_Formula": 0,
    27
          "HasTieredPrice": false,
    28
          "TotalQuantity": 1,
    29
          "IsSellingTermReadOnly": false,
    30
          "IsPrimaryRampLine": false,
    31
          "Uom": "Each",
    32
          "Term": 1,
    33
          "SyncStatus": "Synchronized",
    34
          "StartDate": "2022-03-15",
    35
          "SellingTerm": 1,
    36
          "SellingFrequency": "One Time",
    37
          "RollupPriceToBundle": true,
    38
          "Quantity": 1,
    39
          "ProductId": "01t01000001fE7cAAE",
    40
          "PrimaryLineNumber": 1,
    41
          "PricingStatus": "Pending",
    42
          "PriceUom": "Each",
    43
          "PriceType": "One Time",
    44
          "PriceMethod": "Per Unit",
    45
          "PriceListItemId": "a1601000000WlEtAAK",
    46
          "PriceListId": "a1701000000RMJfAAO",
    47
          "PriceIncludedInBundle": false,
    48
          "NetPrice": 950,
    49
          "NetAdjustmentPercent": 0,
    50
          "ListPrice": 950,
    51
          "LineType": "Product/Service",
    52
          "LineStatus": "New",
    53
          "LineNumber": 1,
    54
          "ItemSequence": 1,
    55
          "IsUsageTierModifiable": false,
    56
          "IsQuantityModifiable": true,
    57
          "IsPrimaryLine": true,
    58
          "IsOptionRollupLine": false,
    59
          "IsCustomPricing": false,
    60
          "IsAssetPricing": false,
    61
          "HasOptions": false,
    62
          "HasDefaults": false,
    63
          "HasBaseProduct": false,
    64
          "HasAttributes": false,
    65
          "Frequency": "One Time",
    66
          "ExtendedQuantity": 1,
    67
          "ExtendedPrice": 950,
    68
          "EndDate": "2022-03-15",
    69
          "Description": "5 Year Extended Warranty",
    70
          "Customizable": false,
    71
          "ConstraintCheckStatus": "NA",
    72
          "ConfigStatus": "NA",
    73
          "Comments": "Added by Code",
    74
          "ChargeType": "Standard Price",
    75
          "BasePrice": 950,
    76
          "BasePriceMethod": "Per Unit",
    77
          "BaseExtendedPrice": 950,
    78
          "AllowableAction": "Unrestricted",
    79
          "AllowRemoval": true,
    80
          "AllowProration": false,
    81
          "AllowManualAdjustment": true,
    82
          "AllocateGroupAdjustment": true,
    83
          "AdjustedPrice": 950,
    84
          "AddedBy": "User",
    85
          "ConfigurationId": "a1I010000011G3XEAU",
    86
          "LastReferencedDate": "2022-03-15T07:25:45.000Z",
    87
          "LastViewedDate": "2022-03-15T07:25:45.000Z",
    88
          "SystemModstamp": "2022-03-15T07:25:45.000Z",
    89
          "LastModifiedById": "00501000001qQDtAAM",
    90
          "LastModifiedDate": "2022-03-15T07:25:45.000Z",
    91
          "CreatedById": "00501000001qQDtAAM",
    92
          "CreatedDate": "2022-03-15T07:25:45.000Z",
    93
          "CurrencyIsoCode": "USD",
    94
          "Name": "LI-0000438478",
    95
          "IsDeleted": false,
    96
          "Id": "a1301000000bpswAAA"
    97
        },
    98
        {
    99
          "Product_Family": "Hardware",
    100
          "Demo_Renewal_flag": "No",
    101
          "APTS_Local_Bundle_Component_Flag": false,
    102
          "ProductVersion": 1,
    103
          "OptionSequence": 0,
    104
          "NetUnitPrice": 800,
    105
          "LineSequence": 2,
    106
          "IsOptional": false,
    107
          "IsHidden": false,
    108
          "HideCopyAction": false,
    109
          "HasIncentives": false,
    110
          "DeltaQuantity": 1,
    111
          "DeltaPrice": 800,
    112
          "AutoRenew": false,
    113
          "Taxable": false,
    114
          "TaxInclusive": false,
    115
          "IsReadOnly": false,
    116
          "HideInvoiceDisplay": false,
    117
          "BillToAccountId": "0011900000hnGsrAAE",
    118
          "Operating_Expense_Formula": 0,
    119
          "HasTieredPrice": false,
    120
          "TotalQuantity": 1,
    121
          "IsSellingTermReadOnly": false,
    122
          "IsPrimaryRampLine": false,
    123
          "Uom": "Each",
    124
          "Term": 1,
    125
          "SyncStatus": "Synchronized",
    126
          "StartDate": "2022-03-15",
    127
          "SellingTerm": 1,
    128
          "SellingFrequency": "One Time",
    129
          "RollupPriceToBundle": true,
    130
          "Quantity": 1,
    131
          "ProductId": "01t01000001fE3gAAE",
    132
          "PrimaryLineNumber": 2,
    133
          "PricingStatus": "Pending",
    134
          "PriceType": "One Time",
    135
          "PriceMethod": "Per Unit",
    136
          "PriceListItemId": "a1601000000WlGvAAK",
    137
          "PriceListId": "a1701000000RMJfAAO",
    138
          "PriceIncludedInBundle": false,
    139
          "NetPrice": 800,
    140
          "NetAdjustmentPercent": 0,
    141
          "ListPrice": 800,
    142
          "LineType": "Product/Service",
    143
          "LineStatus": "New",
    144
          "LineNumber": 2,
    145
          "ItemSequence": 1,
    146
          "IsUsageTierModifiable": false,
    147
          "IsQuantityModifiable": true,
    148
          "IsPrimaryLine": true,
    149
          "IsOptionRollupLine": false,
    150
          "IsCustomPricing": false,
    151
          "IsAssetPricing": false,
    152
          "HasOptions": false,
    153
          "HasDefaults": false,
    154
          "HasBaseProduct": false,
    155
          "HasAttributes": true,
    156
          "Frequency": "One Time",
    157
          "ExtendedQuantity": 1,
    158
          "ExtendedPrice": 800,
    159
          "EndDate": "2022-03-15",
    160
          "Description": "Acer Aspire 5",
    161
          "Customizable": false,
    162
          "ConstraintCheckStatus": "NA",
    163
          "ConfigStatus": "NA",
    164
          "Comments": "Added by Code",
    165
          "ChargeType": "Standard Price",
    166
          "BasePrice": 800,
    167
          "BasePriceMethod": "Per Unit",
    168
          "BaseExtendedPrice": 800,
    169
          "AttributeValueId": "a1F010000029Yx3EAE",
    170
          "AllowableAction": "Unrestricted",
    171
          "AllowRemoval": true,
    172
          "AllowProration": false,
    173
          "AllowManualAdjustment": true,
    174
          "AllocateGroupAdjustment": true,
    175
          "AdjustedPrice": 800,
    176
          "AddedBy": "User",
    177
          "ConfigurationId": "a1I010000011G3XEAU",
    178
          "LastReferencedDate": "2022-03-15T07:25:47.000Z",
    179
          "LastViewedDate": "2022-03-15T07:25:47.000Z",
    180
          "SystemModstamp": "2022-03-15T07:25:47.000Z",
    181
          "LastModifiedById": "00501000001qQDtAAM",
    182
          "LastModifiedDate": "2022-03-15T07:25:47.000Z",
    183
          "CreatedById": "00501000001qQDtAAM",
    184
          "CreatedDate": "2022-03-15T07:25:45.000Z",
    185
          "CurrencyIsoCode": "USD",
    186
          "Name": "LI-0000438479",
    187
          "IsDeleted": false,
    188
          "Id": "a1301000000bpsxAAA"
    189
        }
    190
      ]
    191
    }
    chevron_leftchevron_right
    chevron_right

    Footer Section

    Explore


    Conga.com
    Legal
    Feedback
    Contact Support

    Copyright © 2025 Conga Corporation • All Rights Reserved

    Cookie Notice

    We use cookies to improve your experience on our site. To find out more, read our cookie policy.