home
Release NotesRelease ResourcesGeneralDeveloper Hub

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

      • chevron_right

        CPQ REST API Version 4

      • expand_more

        CPQ REST API Version 5

        • chevron_right

          Authentication

        • expand_more

          Storefront

          • Get Active Storefront

            get
        • chevron_right

          Account

        • chevron_right

          PriceList

        • chevron_right

          Catalog

        • chevron_right

          Carts

        • chevron_right

          Cart Items

        • chevron_right

          Favorites

        • chevron_right

          Generic

        • chevron_right

          Order

        • chevron_right

          Quote

        • chevron_right

          Assets

        • chevron_right

          Collaboration Request

        • chevron_right

          User Views

    • 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

    Storefront

    chevron_right
    download

    Get Active Storefront

    get
    /storefronts/active

    Request to get the active storefront record.

    Request

    Security: Basic Auth

    Query Parameters

    alias
    boolean

    The namespace for the fields are prefixed if set to False. By default it is True.

    Example:
    false
    children
    string

    Query for children of Storefront object.

    Example:
    StoreBanners

    Headers

    x-account
    string

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

    Example:
    0011900000hnGsr
    x-storefront
    string
    required

    The name of the storefront used for the request.

    Example:
    Ecommerce

    Responses

    200

    OK

    Body

    responses
    /
    200
    DefaultPriceList
    string
    required
    StoreBanners
    array[object]
    required
    Title
    string
    Image
    string
    Name
    string
    StorefrontId
    string
    Id
    string
    Id
    string
    required
    OwnerId
    string
    required
    Name
    string
    required
    CurrencyIsoCode
    string
    required
    AssetActions
    string
    required
    DefaultLocale
    string
    required
    EnableTaxCalculations
    boolean
    required
    EnableRequestQuote
    boolean
    required
    EnableABO
    boolean
    required
    EnablePromotions
    boolean
    required
    DefaultAccountforGuestUsers
    object
    required
    Id
    string
    Name
    string
    ChannelType
    string
    required
    Auth
    Username
    :
    Password
    :
    Parameters
    :
    :
    :
    :
    curl --request GET \
      --url https://documentation.conga.com/storefronts/active \
      --header 'Accept: application/json' \
      --header 'Authorization: Basic 123' \
      --header 'x-account: ' \
      --header 'x-storefront: '
    Response Example
    1
    {
    2
      "title": "success",
    3
      "status": 200,
    4
      "data": {
    5
        "CMS": false,
    6
        "CurrencyTypes": [
    7
          {
    8
            "SystemModstamp": "2015-05-06T15:30:13.000Z",
    9
            "LastModifiedById": "005500000026RHkAAM",
    10
            "LastModifiedDate": "2015-05-06T15:30:13.000Z",
    11
            "CreatedById": "005500000026RHkAAM",
    12
            "CreatedDate": "2015-05-06T15:30:13.000Z",
    13
            "IsCorporate": false,
    14
            "IsActive": true,
    15
            "DecimalPlaces": 2,
    16
            "ConversionRate": 20,
    17
            "IsoCode": "AUD",
    18
            "Id": "01L50000000AQc2EAG"
    19
          },
    20
          {
    21
            "SystemModstamp": "2015-02-20T14:49:54.000Z",
    22
            "LastModifiedById": "005500000026QlBAAU",
    23
            "LastModifiedDate": "2015-02-20T14:49:54.000Z",
    24
            "CreatedById": "00550000000vtlpAAA",
    25
            "CreatedDate": "2012-04-20T01:58:09.000Z",
    26
            "IsCorporate": false,
    27
            "IsActive": false,
    28
            "DecimalPlaces": 2,
    29
            "ConversionRate": 2.000001,
    30
            "IsoCode": "CAD",
    31
            "Id": "01L50000000IpuMEAS"
    32
          },
    33
          {
    34
            "SystemModstamp": "2015-02-20T14:49:54.000Z",
    35
            "LastModifiedById": "005500000026QlBAAU",
    36
            "LastModifiedDate": "2015-02-20T14:49:54.000Z",
    37
            "CreatedById": "00550000000vtlpAAA",
    38
            "CreatedDate": "2008-12-23T23:50:30.000Z",
    39
            "IsCorporate": false,
    40
            "IsActive": true,
    41
            "DecimalPlaces": 5,
    42
            "ConversionRate": 2.000001,
    43
            "IsoCode": "CHF",
    44
            "Id": "01L500000008KWLEA2"
    45
          },
    46
          {
    47
            "SystemModstamp": "2015-02-20T14:49:54.000Z",
    48
            "LastModifiedById": "005500000026QlBAAU",
    49
            "LastModifiedDate": "2015-02-20T14:49:54.000Z",
    50
            "CreatedById": "00550000000vtlpAAA",
    51
            "CreatedDate": "2009-02-22T02:15:17.000Z",
    52
            "IsCorporate": false,
    53
            "IsActive": true,
    54
            "DecimalPlaces": 5,
    55
            "ConversionRate": 1,
    56
            "IsoCode": "EUR",
    57
            "Id": "01L500000008KXsEAM"
    58
          },
    59
          {
    60
            "SystemModstamp": "2015-02-20T14:49:54.000Z",
    61
            "LastModifiedById": "005500000026QlBAAU",
    62
            "LastModifiedDate": "2015-02-20T14:49:54.000Z",
    63
            "CreatedById": "00550000000vtlpAAA",
    64
            "CreatedDate": "2009-09-29T08:43:07.000Z",
    65
            "IsCorporate": false,
    66
            "IsActive": true,
    67
            "DecimalPlaces": 5,
    68
            "ConversionRate": 0.63023,
    69
            "IsoCode": "GBP",
    70
            "Id": "01L500000008KcdEAE"
    71
          },
    72
          {
    73
            "SystemModstamp": "2015-02-20T14:49:54.000Z",
    74
            "LastModifiedById": "005500000026QlBAAU",
    75
            "LastModifiedDate": "2015-02-20T14:49:54.000Z",
    76
            "CreatedById": "00550000000wnVTAAY",
    77
            "CreatedDate": "2013-11-19T07:10:32.000Z",
    78
            "IsCorporate": false,
    79
            "IsActive": true,
    80
            "DecimalPlaces": 0,
    81
            "ConversionRate": 1.25,
    82
            "IsoCode": "JPY",
    83
            "Id": "01L50000000J0isEAC"
    84
          },
    85
          {
    86
            "SystemModstamp": "2015-02-20T14:49:54.000Z",
    87
            "LastModifiedById": "005500000026QlBAAU",
    88
            "LastModifiedDate": "2015-02-20T14:49:54.000Z",
    89
            "CreatedById": "0055000000131DoAAI",
    90
            "CreatedDate": "2009-09-15T01:29:28.000Z",
    91
            "IsCorporate": false,
    92
            "IsActive": true,
    93
            "DecimalPlaces": 5,
    94
            "ConversionRate": 2.3,
    95
            "IsoCode": "RUB",
    96
            "Id": "01L500000008KcTEAU"
    97
          },
    98
          {
    99
            "SystemModstamp": "2015-02-20T14:49:54.000Z",
    100
            "LastModifiedById": "005500000026QlBAAU",
    101
            "LastModifiedDate": "2015-02-20T14:49:54.000Z",
    102
            "CreatedById": "00550000000vtlpAAA",
    103
            "CreatedDate": "2009-04-30T17:06:05.000Z",
    104
            "IsCorporate": false,
    105
            "IsActive": true,
    106
            "DecimalPlaces": 5,
    107
            "ConversionRate": 6.300002,
    108
            "IsoCode": "SEK",
    109
            "Id": "01L500000008Ka8EAE"
    110
          },
    111
          {
    112
            "SystemModstamp": "2019-06-05T19:58:54.000Z",
    113
            "LastModifiedById": "00550000000vtlpAAA",
    114
            "LastModifiedDate": "2019-06-05T19:58:54.000Z",
    115
            "CreatedById": "005500000015ntcAAA",
    116
            "CreatedDate": "2008-12-20T01:22:57.000Z",
    117
            "IsCorporate": true,
    118
            "IsActive": true,
    119
            "DecimalPlaces": 2,
    120
            "ConversionRate": 1,
    121
            "IsoCode": "USD",
    122
            "Id": "01L500000008KW6EAM"
    123
          }
    124
        ],
    125
        "Storefront": {
    126
          "DefaultAccountforGuestUsersId": "0015000000Fn6m0AAB",
    127
          "DefaultPriceList": {
    128
            "APTS_Ext_ID": "a171T000005il1XQAQ",
    129
            "DisableBasedOnCurrencyAdjustment": false,
    130
            "Type": "Contract",
    131
            "GuidePage": "APTPSGuidedSelling",
    132
            "EffectiveDate": "2018-10-31T08:22:00.000Z",
    133
            "Active": true,
    134
            "SystemModstamp": "2020-01-16T06:57:01.000Z",
    135
            "LastModifiedById": "00550000000vtlpAAA",
    136
            "LastModifiedDate": "2020-01-16T06:57:01.000Z",
    137
            "CreatedById": "00550000000vtlpAAA",
    138
            "CreatedDate": "2019-05-08T11:14:39.000Z",
    139
            "CurrencyIsoCode": "USD",
    140
            "Name": "Tier 1 Hardware & Software",
    141
            "IsDeleted": false,
    142
            "OwnerId": "00550000000vtlpAAA",
    143
            "Id": "a171T000005il1XQAQ"
    144
          },
    145
          "StoreBanners": [
    146
            {
    147
              "Title": "Lorem ipsum dolor",
    148
              "Subtitle": "Mauris urna libero, aliquet quis est quis, tincidunt gravida ex. Morbi et magna tempus, hendrerit neque eget, convallis ex. Suspendisse quis orci in odio pulvinar tincidunt sed eget magna.",
    149
              "Image": "https://picsum.photos/800/400/?random",
    150
              "SystemModstamp": "2019-09-16T06:16:32.000Z",
    151
              "LastModifiedById": "00550000000vtlpAAA",
    152
              "LastModifiedDate": "2019-09-16T06:16:32.000Z",
    153
              "CreatedById": "00550000000vtlpAAA",
    154
              "CreatedDate": "2019-09-16T06:16:32.000Z",
    155
              "CurrencyIsoCode": "USD",
    156
              "Name": "SB-00001",
    157
              "IsDeleted": false,
    158
              "Id": "a5m230000008VYRAA2",
    159
              "StorefrontId": "a5n23000000A7xGAAS"
    160
            }
    161
          ],
    162
          "Payment_Callback_URL": "https://eng-ecom.apttuscloud.io/ui/pcom/qa/payment/payment-message",
    163
          "ChannelType": "Partner Quoting",
    164
          "TranslationURL": "/apex/APTS_EcommerceTranslator//",
    165
          "Logo": "https://2wyzqu1t50vr2esar426fpzd-wpengine.netdna-ssl.com/wp-content/uploads/2015/12/APTTUS_NEW_LOGO.png",
    166
          "EnableTaxCalculations": true,
    167
          "EnableRequestQuote": true,
    168
          "EnablePromotions": true,
    169
          "EnableABO": true,
    170
          "DefaultPriceListId": "a171T000005il1XQAQ",
    171
          "DefaultLocale": "es-MX",
    172
          "DefaultAccountforGuestUsers": {
    173
            "ReadyForInvoiceDate": "2019-11-18",
    174
            "ExcludeFromDunning": false,
    175
            "PriceListId": "a1750000004umt4AAA",
    176
            "TaxExempt": "No",
    177
            "TaxID": "11542237",
    178
            "IsCustomerPortal": true,
    179
            "IsPartner": true,
    180
            "SystemModstamp": "2019-11-19T05:22:34.000Z",
    181
            "LastModifiedById": "00550000000vtlpAAA",
    182
            "LastModifiedDate": "2019-11-19T05:22:34.000Z",
    183
            "CreatedById": "00550000000vtlpAAA",
    184
            "CreatedDate": "2006-10-19T20:54:20.000Z",
    185
            "OwnerId": "00550000000vtlpAAA",
    186
            "CurrencyIsoCode": "USD",
    187
            "Rating": "Warm",
    188
            "Ownership": "Public",
    189
            "NumberOfEmployees": 680,
    190
            "AnnualRevenue": 100000000,
    191
            "Industry": "Manufacturing",
    192
            "Website": "www.acme.com",
    193
            "Fax": "(212) 555-5555",
    194
            "Phone": "(212) 555-5555",
    195
            "ShippingAddress": {
    196
              "city": "TEXAS",
    197
              "country": "United States",
    198
              "countryCode": "US",
    199
              "geocodeAccuracy": null,
    200
              "latitude": null,
    201
              "longitude": null,
    202
              "postalCode": "85705",
    203
              "state": "Texas",
    204
              "stateCode": "TX",
    205
              "street": "St Joseph"
    206
            },
    207
            "ShippingCountryCode": "US",
    208
            "ShippingStateCode": "TX",
    209
            "ShippingCountry": "United States",
    210
            "ShippingPostalCode": "85705",
    211
            "ShippingState": "Texas",
    212
            "ShippingCity": "TEXAS",
    213
            "ShippingStreet": "St Joseph",
    214
            "BillingAddress": {
    215
              "city": "California",
    216
              "country": "United States",
    217
              "countryCode": "US",
    218
              "geocodeAccuracy": null,
    219
              "latitude": null,
    220
              "longitude": null,
    221
              "postalCode": "85705",
    222
              "state": "California",
    223
              "stateCode": "CA",
    224
              "street": "St Merry"
    225
            },
    226
            "BillingCountryCode": "US",
    227
            "BillingStateCode": "CA",
    228
            "BillingCountry": "United States",
    229
            "BillingPostalCode": "85705",
    230
            "BillingState": "California",
    231
            "BillingCity": "California",
    232
            "BillingStreet": "St Merry",
    233
            "Type": "Prospect",
    234
            "Name": "Acme",
    235
            "IsDeleted": false,
    236
            "Id": "0015000000Fn6m0AAB"
    237
          },
    238
          "AssetActions": "Buy More;Renew;Terminate;Change Configuration",
    239
          "SystemModstamp": "2020-07-27T06:23:56.000Z",
    240
          "LastModifiedById": "00550000000vtlpAAA",
    241
          "LastModifiedDate": "2020-07-27T06:23:56.000Z",
    242
          "CreatedById": "00550000000vtlpAAA",
    243
          "CreatedDate": "2019-09-16T06:14:52.000Z",
    244
          "CurrencyIsoCode": "USD",
    245
          "Name": "P-Commerce",
    246
          "IsDeleted": false,
    247
          "OwnerId": "00550000000vtlpAAA",
    248
          "Id": "a5n23000000A7xGAAS"
    249
        }
    250
      }
    251
    }
    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.