Release Notes Release Resources General Developer Hub

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

Digital Commerce for Salesforce REST APIs

Discovery AI for Salesforce REST APIs

Orchestrate REST APIs

TurboEngines REST APIs

download

Get Product Rules

get

/products/{productId}/rules

Get the constraint rules associated with the specified product. Query parameters can be used to create more specific criteria for what is returned.

Request

Security: Basic Auth

Path Parameters

productId

string

required

The name of the id of the product to retrieve.

Example:

01t19000005GM8fAAG

Query Parameters

alias

boolean

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

Example:

false

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

x-account

string

The account value from the 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

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

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

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 Product Rules

Request

Path Parameters

Query Parameters

Headers

Responses

Body

Footer Section

Explore