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)Conga CopilotCPQ 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 SearchTest AuthorTurboEnginesX-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 Manager for Advantage PlatformX-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)Conga CopilotCPQ 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 SearchTest AuthorTurboEnginesX-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 Manager for Advantage PlatformX-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

        • chevron_right

          Storefront

        • chevron_right

          Account

        • chevron_right

          PriceList

        • chevron_right

          Catalog

        • expand_more

          Carts

          • Get Active Cart

            get

          • Update Cart

            put

          • Delete Cart

            delete

          • Get Cart Rules

            get

          • Create Cart

            post

          • Clone Cart

            post

          • Abandon Cart

            post

          • Create Proposal

            post

          • Apply Promotion to Cart

            post

          • Remove Promotion from Cart

            delete

          • Price Cart

            post
        • 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

  1. General
  2. arrow_right
  3. Developer Center
  4. arrow_right
  5. Digital Commerce for Salesforce REST APIs
  6. arrow_right
  7. CPQ REST API Version 5

list_altShow Contents

chevron_left

General

Carts

chevron_right
download

Update Cart

put
/carts/{cartId}

Updates a cart on the server that matches the cartId path variable. The fields to be updated need to be passed in to the body of the request.

Request

Security: Basic Auth

Path Parameters

cartId
string
required

The reference to the cart or 'active' for the current active cart.

Example:
a1I3I000000e7GLUAY

Query Parameters

alias
boolean

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

Example:
false
price
string
required

The pricing strategy to use. 'default' | 'async' | 'skip'

Example:
skip
rule
string
required

The rule strategy to use. 'default' | 'async' | 'skip'

Example:
skip

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 must include the cart object with the updated fields to be applied to the specified cart on the server.

Name
string

Responses

200

OK

Body

responses
/
200
Id
string
required
Name
string
required
IsPricePending
boolean
required
LineItems
array[object]
required
Account
string
required
ShipToAccount
string
required
BillToAccount
string
required
AppliedRuleActionInfo
array[object]
required
SummaryGroups
array[object]
required
AppliedRuleInfo
array[object]
required
Auth
Username
:
Password
:
Parameters
:
:
:
:
:
:
:
Body
1
{
2
  "Name": "Renamed Cart"
3
}
curl --request PUT \
  --url https://documentation.conga.com/carts/cartId \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123' \
  --header 'Content-Type: application/json' \
  --header 'x-account: ' \
  --header 'x-storefront: ' \
  --data '{
  "Name": "Renamed Cart"
}'
Response Example
1
{
2
  "title": "success",
3
  "status": 200,
4
  "data": [
5
    {
6
      "PriceList": {
7
        "APTS_Ext_ID": "a171T000005il1XQAQ",
8
        "DisableBasedOnCurrencyAdjustment": false,
9
        "Type": "Contract",
10
        "GuidePage": "APTPSGuidedSelling",
11
        "EffectiveDate": "2018-10-31T08:22:00.000Z",
12
        "Active": true,
13
        "SystemModstamp": "2020-01-16T06:57:01.000Z",
14
        "LastModifiedById": "00550000000vtlpAAA",
15
        "LastModifiedDate": "2020-01-16T06:57:01.000Z",
16
        "CreatedById": "00550000000vtlpAAA",
17
        "CreatedDate": "2019-05-08T11:14:39.000Z",
18
        "CurrencyIsoCode": "USD",
19
        "Name": "Tier 1 Hardware & Software",
20
        "IsDeleted": false,
21
        "OwnerId": "00550000000vtlpAAA",
22
        "Id": "a171T000005il1XQAQ"
23
      },
24
      "Account": {
25
        "Owner": {
26
          "BadgeText": "Apttus",
27
          "OutOfOfficeMessage": "",
28
          "IsProfilePhotoActive": true,
29
          "MediumBannerPhotoUrl": "/pcom/profilephoto/005/E",
30
          "SmallBannerPhotoUrl": "/pcom/profilephoto/005/D",
31
          "BannerPhotoUrl": "/pcom/profilephoto/005/B",
32
          "DefaultGroupNotificationFrequency": "D",
33
          "DigestFrequency": "N",
34
          "MediumPhotoUrl": "/pcom/profilephoto/005/M",
35
          "IsExtIndicatorVisible": false,
36
          "SmallPhotoUrl": "/pcom/profilephoto/005/T",
37
          "FullPhotoUrl": "/pcom/profilephoto/005/F",
38
          "IsPortalEnabled": false,
39
          "ForecastEnabled": true,
40
          "SystemModstamp": "2020-07-27T06:19:46.000Z",
41
          "LastModifiedById": "00550000000vtlpAAA",
42
          "LastModifiedDate": "2020-07-24T06:27:48.000Z",
43
          "CreatedById": "00550000000vtlpAAA",
44
          "CreatedDate": "2006-10-19T20:54:04.000Z",
45
          "LastLoginDate": "2020-07-27T06:11:31.000Z",
46
          "LanguageLocaleKey": "en_US",
47
          "UserType": "Standard",
48
          "CurrencyIsoCode": "USD",
49
          "DefaultCurrencyIsoCode": "USD",
50
          "EmailEncodingKey": "ISO-8859-1",
51
          "ReceivesAdminInfoEmails": false,
52
          "ReceivesInfoEmails": false,
53
          "LocaleSidKey": "en_US",
54
          "TimeZoneSidKey": "America/Los_Angeles",
55
          "IsActive": true,
56
          "CommunityNickname": "qamgr",
57
          "Alias": "qamgr",
58
          "SenderEmail": "qa@apttus.com",
59
          "EmailPreferencesStayInTouchReminder": false,
60
          "EmailPreferencesAutoBccStayInTouch": false,
61
          "EmailPreferencesAutoBcc": true,
62
          "Address": null,
63
          "Title": "QA Manager",
64
          "CompanyName": "Apttus",
65
          "Name": "QA Manager",
66
          "FirstName": "QA",
67
          "LastName": "Manager",
68
          "Username": "qa@apttus.com.dc4",
69
          "Id": "00550000000vtlpAAA"
70
        },
71
        "PriceList": {
72
          "APTS_Ext_ID": "a171T000005il1XQAQ",
73
          "DisableBasedOnCurrencyAdjustment": false,
74
          "Type": "Contract",
75
          "GuidePage": "APTPSGuidedSelling",
76
          "EffectiveDate": "2018-10-31T08:22:00.000Z",
77
          "Active": true,
78
          "SystemModstamp": "2020-01-16T06:57:01.000Z",
79
          "LastModifiedById": "00550000000vtlpAAA",
80
          "LastModifiedDate": "2020-01-16T06:57:01.000Z",
81
          "CreatedById": "00550000000vtlpAAA",
82
          "CreatedDate": "2019-05-08T11:14:39.000Z",
83
          "CurrencyIsoCode": "USD",
84
          "Name": "Tier 1 Hardware & Software",
85
          "IsDeleted": false,
86
          "OwnerId": "00550000000vtlpAAA",
87
          "Id": "a171T000005il1XQAQ"
88
        },
89
        "ReadyForInvoiceDate": "2019-10-15",
90
        "ExcludeFromDunning": false,
91
        "CustomerPriority": "High",
92
        "PriceListId": "a171T000005il1XQAQ",
93
        "BillingPreferenceId": "a2d19000001VUE4AAO",
94
        "BillingDayOfMonth": "1st of the Month",
95
        "TaxExempt": "No",
96
        "CertificateId": "a2s19000000RGuGAAW",
97
        "IsCustomerPortal": true,
98
        "IsPartner": true,
99
        "LastActivityDate": "2020-07-27",
100
        "SystemModstamp": "2020-07-27T04:55:59.000Z",
101
        "LastModifiedById": "00550000000vtlpAAA",
102
        "LastModifiedDate": "2020-07-20T05:05:48.000Z",
103
        "CreatedById": "00550000000vtlpAAA",
104
        "CreatedDate": "2019-05-09T08:17:08.000Z",
105
        "OwnerId": "00550000000vtlpAAA",
106
        "CurrencyIsoCode": "USD",
107
        "Industry": "Other",
108
        "Fax": "(211) 555-5556",
109
        "Phone": "(211) 555-5555",
110
        "ShippingAddress": {
111
          "city": "Bangalore",
112
          "country": "India",
113
          "countryCode": "IN",
114
          "geocodeAccuracy": null,
115
          "latitude": null,
116
          "longitude": null,
117
          "postalCode": "560103",
118
          "state": "Karnataka",
119
          "stateCode": "KA",
120
          "street": "14 Dry Island #111"
121
        },
122
        "ShippingCountryCode": "IN",
123
        "ShippingStateCode": "KA",
124
        "ShippingCountry": "India",
125
        "ShippingPostalCode": "560103",
126
        "ShippingState": "Karnataka",
127
        "ShippingCity": "Bangalore",
128
        "ShippingStreet": "14 Dry Island #111",
129
        "BillingAddress": {
130
          "city": "San Mateo",
131
          "country": "United States",
132
          "countryCode": "US",
133
          "geocodeAccuracy": null,
134
          "latitude": null,
135
          "longitude": null,
136
          "postalCode": "84321",
137
          "state": "Utah",
138
          "stateCode": "UT",
139
          "street": "1400 Fashion Island Blvd #100"
140
        },
141
        "BillingCountryCode": "US",
142
        "BillingStateCode": "UT",
143
        "BillingCountry": "United States",
144
        "BillingPostalCode": "84321",
145
        "BillingState": "Utah",
146
        "BillingCity": "San Mateo",
147
        "BillingStreet": "1400 Fashion Island Blvd #100",
148
        "Name": "ABC Corporation",
149
        "IsDeleted": false,
150
        "Id": "0011900000hnGsrAAE"
151
      },
152
      "BillToAccount": {
153
        "ReadyForInvoiceDate": "2019-10-15",
154
        "ExcludeFromDunning": false,
155
        "CustomerPriority": "High",
156
        "PriceListId": "a171T000005il1XQAQ",
157
        "BillingPreferenceId": "a2d19000001VUE4AAO",
158
        "BillingDayOfMonth": "1st of the Month",
159
        "TaxExempt": "No",
160
        "CertificateId": "a2s19000000RGuGAAW",
161
        "IsCustomerPortal": true,
162
        "IsPartner": true,
163
        "LastActivityDate": "2020-07-27",
164
        "SystemModstamp": "2020-07-27T04:55:59.000Z",
165
        "LastModifiedById": "00550000000vtlpAAA",
166
        "LastModifiedDate": "2020-07-20T05:05:48.000Z",
167
        "CreatedById": "00550000000vtlpAAA",
168
        "CreatedDate": "2019-05-09T08:17:08.000Z",
169
        "OwnerId": "00550000000vtlpAAA",
170
        "CurrencyIsoCode": "USD",
171
        "Industry": "Other",
172
        "Fax": "(211) 555-5556",
173
        "Phone": "(211) 555-5555",
174
        "ShippingAddress": {
175
          "city": "Bangalore",
176
          "country": "India",
177
          "countryCode": "IN",
178
          "geocodeAccuracy": null,
179
          "latitude": null,
180
          "longitude": null,
181
          "postalCode": "560103",
182
          "state": "Karnataka",
183
          "stateCode": "KA",
184
          "street": "14 Dry Island #111"
185
        },
186
        "ShippingCountryCode": "IN",
187
        "ShippingStateCode": "KA",
188
        "ShippingCountry": "India",
189
        "ShippingPostalCode": "560103",
190
        "ShippingState": "Karnataka",
191
        "ShippingCity": "Bangalore",
192
        "ShippingStreet": "14 Dry Island #111",
193
        "BillingAddress": {
194
          "city": "San Mateo",
195
          "country": "United States",
196
          "countryCode": "US",
197
          "geocodeAccuracy": null,
198
          "latitude": null,
199
          "longitude": null,
200
          "postalCode": "84321",
201
          "state": "Utah",
202
          "stateCode": "UT",
203
          "street": "1400 Fashion Island Blvd #100"
204
        },
205
        "BillingCountryCode": "US",
206
        "BillingStateCode": "UT",
207
        "BillingCountry": "United States",
208
        "BillingPostalCode": "84321",
209
        "BillingState": "Utah",
210
        "BillingCity": "San Mateo",
211
        "BillingStreet": "1400 Fashion Island Blvd #100",
212
        "Name": "ABC Corporation",
213
        "IsDeleted": false,
214
        "Id": "0011900000hnGsrAAE"
215
      },
216
      "ShipToAccount": {
217
        "ReadyForInvoiceDate": "2019-10-15",
218
        "ExcludeFromDunning": false,
219
        "CustomerPriority": "High",
220
        "PriceListId": "a171T000005il1XQAQ",
221
        "BillingPreferenceId": "a2d19000001VUE4AAO",
222
        "BillingDayOfMonth": "1st of the Month",
223
        "TaxExempt": "No",
224
        "CertificateId": "a2s19000000RGuGAAW",
225
        "IsCustomerPortal": true,
226
        "IsPartner": true,
227
        "LastActivityDate": "2020-07-27",
228
        "SystemModstamp": "2020-07-27T04:55:59.000Z",
229
        "LastModifiedById": "00550000000vtlpAAA",
230
        "LastModifiedDate": "2020-07-20T05:05:48.000Z",
231
        "CreatedById": "00550000000vtlpAAA",
232
        "CreatedDate": "2019-05-09T08:17:08.000Z",
233
        "OwnerId": "00550000000vtlpAAA",
234
        "CurrencyIsoCode": "USD",
235
        "Industry": "Other",
236
        "Fax": "(211) 555-5556",
237
        "Phone": "(211) 555-5555",
238
        "ShippingAddress": {
239
          "city": "Bangalore",
240
          "country": "India",
241
          "countryCode": "IN",
242
          "geocodeAccuracy": null,
243
          "latitude": null,
244
          "longitude": null,
245
          "postalCode": "560103",
246
          "state": "Karnataka",
247
          "stateCode": "KA",
248
          "street": "14 Dry Island #111"
249
        },
250
        "ShippingCountryCode": "IN",
251
        "ShippingStateCode": "KA",
252
        "ShippingCountry": "India",
253
        "ShippingPostalCode": "560103",
254
        "ShippingState": "Karnataka",
255
        "ShippingCity": "Bangalore",
256
        "ShippingStreet": "14 Dry Island #111",
257
        "BillingAddress": {
258
          "city": "San Mateo",
259
          "country": "United States",
260
          "countryCode": "US",
261
          "geocodeAccuracy": null,
262
          "latitude": null,
263
          "longitude": null,
264
          "postalCode": "84321",
265
          "state": "Utah",
266
          "stateCode": "UT",
267
          "street": "1400 Fashion Island Blvd #100"
268
        },
269
        "BillingCountryCode": "US",
270
        "BillingStateCode": "UT",
271
        "BillingCountry": "United States",
272
        "BillingPostalCode": "84321",
273
        "BillingState": "Utah",
274
        "BillingCity": "San Mateo",
275
        "BillingStreet": "1400 Fashion Island Blvd #100",
276
        "Name": "ABC Corporation",
277
        "IsDeleted": false,
278
        "Id": "0011900000hnGsrAAE"
279
      },
280
      "UseType": "Main",
281
      "BusinessObjectProfile": "Regular",
282
      "IsValidationPending": false,
283
      "IsTaskPending": false,
284
      "ShipToAccountId": "0011900000hnGsrAAE",
285
      "CartDataCache": "{\n  \"usePriceEscalators\" : false,\n  \"useFormulaPricing\" : false,\n  \"useBasicTotaling\" : false,\n  \"splitCartThreshold\" : null,\n  \"splitCartCriteriaFields\" : null,\n  \"priceInErrorLineNumbers\" : null,\n  \"priceCompletedLineNumbers\" : null,\n  \"priceCompletedChunkLineNumbers\" : null,\n  \"pendingDepItemKeys\" : [ ],\n  \"lastIndex\" : 0,\n  \"lastChunkItemSequence\" : null,\n  \"IsProductGroupEnabled\" : false,\n  \"IsProductFamilyEnabled\" : false,\n  \"isPrestoCallPending\" : null,\n  \"isPrePricingStepPending\" : null,\n  \"isPostPricingStepPending\" : null,\n  \"IsOptionPricePending\" : false,\n  \"IsEmpty\" : false,\n  \"IsCustomGroupEnabled\" : false,\n  \"idxCType\" : { },\n  \"DependentItemKeyMap\" : { },\n  \"currAdHocGrouByField\" : null,\n  \"cTypeIdx\" : { },\n  \"couponUsage\" : { },\n  \"couponCodes\" : [ ],\n  \"chunkBundleLineNumber\" : null\n}",
286
      "BillToAccountId": "0011900000hnGsrAAE",
287
      "EffectivePriceListId": "a171T000005il1XQAQ",
288
      "NumberOfItems": 2,
289
      "BaseRelationCount": 0,
290
      "SummaryGroupType": "Category",
291
      "Status": "New",
292
      "PriceListId": "a171T000005il1XQAQ",
293
      "IsTransient": true,
294
      "IsPricePending": false,
295
      "EffectiveDate": "2020-07-27T05:58:12.000Z",
296
      "BusinessObjectType": "Agreement",
297
      "AccountId": "0011900000hnGsrAAE",
298
      "LastReferencedDate": "2020-07-27T07:58:22.000Z",
299
      "LastViewedDate": "2020-07-27T07:58:22.000Z",
300
      "SystemModstamp": "2020-07-27T07:58:22.000Z",
301
      "LastModifiedById": "00519000002cNFCAA2",
302
      "LastModifiedDate": "2020-07-27T07:58:22.000Z",
303
      "CreatedById": "00519000002cNFCAA2",
304
      "CreatedDate": "2020-07-27T05:58:13.000Z",
305
      "CurrencyIsoCode": "USD",
306
      "Name": "New Name 3",
307
      "IsDeleted": false,
308
      "OwnerId": "00519000002cNFCAA2",
309
      "Id": "a1I3I000000ZhIQUA0"
310
    }
311
  ]
312
}
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.