General

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.

General

chevron_left

General Contents

Features by Release

Conga Upgrade Program

System Requirements and Supported Platforms Matrix

Managed Packages Dependency Matrix

Conga Applications in Salesforce Lightning

Salesforce Multi-Factor Authentication Support for Conga Commerce

Conga Product Glossary

Conga Upgrade Assistant

Product Retirement Schedule

Developer Center

Approvals for Salesforce REST APIs

Billing for Salesforce REST APIs

CLM for Salesforce REST APIs

CPQ for Salesforce REST APIs

Discovery AI for Salesforce REST APIs

Orchestrate REST APIs

Partner Commerce for Salesforce REST APIs

TurboEngines REST APIs

download

Get Multiple Product Rules

post

/products/rules

Get constraint rules for multiple products at once by passing in an array of ids for the products you wish to retrieve. Query parameters can be used to create more specific criteria for what is returned.

Request

Security: Basic Auth

Query Parameters

matchInOptions

boolean

When set to True, returns rules for options.

Example:

true

matchInPrimaryLines

boolean

When set to True, returns rules for primary lines.

Example:

true

Headers

Content-Type

string

Content type of the request body.

Example:

application/json

x-account

string

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

Example:

0011900000hnGsr

x-storefront

string

required

The name of the storefront used for the request.

Example:

Ecommerce

Body

array of:

Example:

[{"Id":"01t1T000005BXoUQAW"},{"Id":"01t1T000005BXnbQAG"}]

Responses

200

Body

responses

200

string

required

Name

string

required

ConstraintRuleConditions

array[object]

required

ConstraintRuleId

string

ProductId

string

ProductScope

string

ConstraintRuleActions

array[object]

required

ConstraintRuleId

string

ProductId

string

ProductScope

string

ActionType

string

AutoInclude

boolean

Message

string

MatchInOptions

boolean

required

MatchInPrimaryLines

boolean

required

Active

boolean

required

Auth

Username

Password

Parameters

Body

[
  {
    "Id": "01t1T000005BXoUQAW"
  },
  {
    "Id": "01t1T000005BXnbQAG"
  }
]

1
[
2
  {
3
    "Id": "01t1T000005BXoUQAW"
4
  },
5
  {
6
    "Id": "01t1T000005BXnbQAG"
7
  }
8
]

curl --request POST \
  --url https://documentation.conga.com/products/rules \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123' \
  --header 'Content-Type: application/json' \
  --header 'x-account: ' \
  --header 'x-storefront: ' \
  --data '[
  {
    "Id": "01t1T000005BXoUQAW"
  },
  {
    "Id": "01t1T000005BXnbQAG"
  }
]'

Response Example

1
{
2
  "title": "success",
3
  "status": 200,
4
  "data": {
5
    "01t1T000005BXoUQAW": [
6
      {
7
        "APTS_Ext_ID": "a0v1T00000DUeNZQA1",
8
        "IsBundleContext": false,
9
        "MatchInOptions": false,
10
        "LastModifiedById": "00550000000vtlpAAA",
11
        "ConstraintRuleConditions": [
12
          {
13
            "APTS_Ext_ID": "a0u1T00000J88U1QAJ",
14
            "MatchInOptions": false,
15
            "LastModifiedById": "00550000000vtlpAAA",
16
            "Id": "a0u1T00000J88U1QAJ",
17
            "CreatedDate": "2019-05-08T11:52:21.000Z",
18
            "MatchInAsset": false,
19
            "MatchInCartOptions": false,
20
            "SystemModstamp": "2020-01-16T06:56:58.000Z",
21
            "ProductId": "01t1T000005BXoUQAW",
22
            "CurrencyIsoCode": "SEK",
23
            "ProductFieldOperatorB": "equal to",
24
            "IsDeleted": false,
25
            "ProductFieldOperatorD": "equal to",
26
            "MatchInLocation": false,
27
            "Sequence": 1,
28
            "MatchInRelatedLines": false,
29
            "ProductScope": "Product",
30
            "ConstraintRuleId": "a0v1T00000DUeNZQA1",
31
            "CreatedById": "00550000000vtlpAAA",
32
            "Name": "DL 160 Gen8 Default",
33
            "EditCriteria": "<a href=\"/apex/Apttus_Config2__ConstraintRuleConditionCriteriaEdit?id=a0u1T00000J88U1\" target=\"_self\"><img src=\"/resource/Apttus_Config2__Button_EditCriteria\" alt=\"Edit Criteria\" border=\"0\"/></a>",
34
            "MatchInPrimaryLines": true,
35
            "ProductFieldOperatorA": "equal to",
36
            "ProductFieldOperatorC": "equal to",
37
            "LastModifiedDate": "2020-01-16T06:56:58.000Z"
38
          }
39
        ],
40
        "UpdateView": "<a href=\"/apex/Apttus_Config2__ProductConstraintView?ruleId=a0v1T00000DUeNZ\" target=\"_self\"><img src=\"/resource/Apttus_Config2__Button_UpdateView\" alt=\"Update View\" border=\"0\"/></a>",
41
        "Id": "a0v1T00000DUeNZQA1",
42
        "CreatedDate": "2019-05-08T11:18:00.000Z",
43
        "ConstraintRuleActions": [
44
          {
45
            "APTS_Ext_ID": "a0t1T00000IS53gQAD",
46
            "MatchInOptions": false,
47
            "LastModifiedById": "00550000000vtlpAAA",
48
            "ActionType": "Inclusion",
49
            "AutoInclude": false,
50
            "Id": "a0t1T00000IS53gQAD",
51
            "RepeatInclusion": false,
52
            "CreatedDate": "2019-05-08T11:48:58.000Z",
53
            "MatchInAsset": false,
54
            "MatchInCartOptions": false,
55
            "SystemModstamp": "2020-01-16T06:56:56.000Z",
56
            "ProductId": "01t1T000005BXpkQAG",
57
            "AutoExclude": false,
58
            "CurrencyIsoCode": "SEK",
59
            "Message": "{1} is included on the addition of {0}",
60
            "ActionIntent": "Auto Include",
61
            "IsDeleted": false,
62
            "Product": {
63
              "APTS_Ext_ID": "01t1T000005BXpkQAG",
64
              "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t1T000005BXpk\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e3EEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
65
              "LastModifiedById": "00550000000vtlpAAA",
66
              "IconSize": "225x225",
67
              "Id": "01t1T000005BXpkQAG",
68
              "Family": "Hardware",
69
              "CreatedDate": "2019-05-08T11:12:53.000Z",
70
              "ExcludeFromSitemap": false,
71
              "IsArchived": false,
72
              "SystemModstamp": "2020-01-16T06:57:21.000Z",
73
              "CurrencyIsoCode": "SEK",
74
              "PriceLists": [
75
                {
76
                  "APTS_Ext_ID": "a161T000004znFYQAY",
77
                  "PriceListId": "a171T000005il1XQAQ",
78
                  "LastModifiedById": "00550000000vtlpAAA",
79
                  "Id": "a161T000004znFYQAY",
80
                  "AutoCascadeSellingTerm": false,
81
                  "CreatedDate": "2019-05-08T11:16:00.000Z",
82
                  "PriceMethod": "Per Unit",
83
                  "SystemModstamp": "2020-01-16T06:57:25.000Z",
84
                  "PriceUom": "Each",
85
                  "ProductId": "01t1T000005BXpkQAG",
86
                  "CurrencyIsoCode": "SEK",
87
                  "IsUsageTierModifiable": false,
88
                  "HasCriteria": false,
89
                  "EnablePriceRamp": false,
90
                  "AllowProration": false,
91
                  "DisableAssetIntegration": false,
92
                  "ListPrice": 100,
93
                  "ProductFamily": "Hardware",
94
                  "PriceType": "One Time",
95
                  "ProductName": "DLL 160 Gen8 Default Support",
96
                  "AllocateGroupAdjustment": true,
97
                  "EnableAutoRampCreation": false,
98
                  "RollupPriceToBundle": true,
99
                  "IsDeleted": false,
100
                  "DisableSyncWithOpportunity": false,
101
                  "AllowPriceRampOverlap": false,
102
                  "AutoRenew": false,
103
                  "IsQuantityReadOnly": false,
104
                  "CreatedById": "00550000000vtlpAAA",
105
                  "Active": true,
106
                  "Name": "PI-0000000468",
107
                  "TaxInclusive": false,
108
                  "AutoCascadeQuantity": false,
109
                  "AllowManualAdjustment": true,
110
                  "EnableCommitment": false,
111
                  "ProductActive": true,
112
                  "NumberOfMatrices": 0,
113
                  "IsSellingTermReadOnly": false,
114
                  "PriceIncludedInBundle": false,
115
                  "ProductCode": "TEST1",
116
                  "DisableCostModel": false,
117
                  "Taxable": false,
118
                  "LastModifiedDate": "2020-01-16T06:57:24.000Z"
119
                }
120
              ],
121
              "Customizable": false,
122
              "HasDefaults": false,
123
              "ProductCode": "TEST1",
124
              "Version": 1,
125
              "IsDeleted": false,
126
              "HasAttributes": false,
127
              "ShowTabView": false,
128
              "CreatedById": "00550000000vtlpAAA",
129
              "IconId": "00P190000025e3EEAQ",
130
              "Name": "DLL 160 Gen8 Default Support",
131
              "Uom": "Each",
132
              "ConfigurationType": "Standalone",
133
              "HasSearchAttributes": false,
134
              "HasOptions": false,
135
              "IsActive": true,
136
              "LastModifiedDate": "2020-01-16T06:57:20.000Z"
137
            },
138
            "Sequence": 1,
139
            "ProductScope": "Product",
140
            "ConstraintRuleId": "a0v1T00000DUeNZQA1",
141
            "CreatedById": "00550000000vtlpAAA",
142
            "Name": "DL 160 Gen8 Default Support",
143
            "EditCriteria": "<a href=\"/apex/Apttus_Config2__ConstraintRuleActionCriteriaEdit?id=a0t1T00000IS53g\" target=\"_self\"><img src=\"/resource/Apttus_Config2__Button_EditCriteria\" alt=\"Edit Criteria\" border=\"0\"/></a>",
144
            "MatchInPrimaryLines": true,
145
            "LastModifiedDate": "2020-01-16T06:56:56.000Z",
146
            "ActionDisposition": "Error"
147
          }
148
        ],
149
        "MatchInAsset": false,
150
        "CreatedById": "00550000000vtlpAAA",
151
        "OwnerId": "00550000000vtlpAAA",
152
        "Active": true,
153
        "SystemModstamp": "2020-01-16T06:56:59.000Z",
154
        "Name": "Inclusion for DL 160 Gen8 Default",
155
        "CurrencyIsoCode": "SEK",
156
        "MatchInPrimaryLines": false,
157
        "IsDeleted": false,
158
        "LastModifiedDate": "2020-01-16T06:56:59.000Z"
159
      }
160
    ]
161
  }
162
}

chevron_right

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.

Get Multiple Product Rules

Request

Query Parameters

Headers

Body

Responses

Body

Footer Section

Explore