Service Catalog

Create an extended Case object that includes custom data about a customer request such as a fee reversal or address update. To define the custom data, go to the Service Process Studio in Setup, create a Service Process definition, and configure attributes. Specify the Service Process definition and attribute values in the POST request body.

Resources

POST:

1/connect/service-excellence/service-catalog-request

GET:

1/connect/service-excellence/service-catalog-request/${svcCatalogRequestId}

Resource Example

1https://yourInstance.salesforce.com/services/data/v57.0/connect/service-excellence/service-catalog-request/${svcCatalogRequestId}

Available Version

57.0

Requires Chatter

HTTP Methods

POST, GET

Path Parameters

Name	Type	Description	Required or Optional	Available Version
svcCatalogRequestId	String	Identifies a previous POST request to be retrieved with GET.	Required for GET	57.0

Request Body for POST

The attributes data structure in the request body must match the attributes configured in the Service Process definition.

JSON Format

1{
2  "svcCatalogItemDefApiName": "AddressUpdate",
3  "attributes": {
4    "data": {
5      "AttrName1": {
6        "value": "some text"
7      },
8      "AttrName2": {
9        "value": {
10          "Value1": 123,
11          "Value2": 456
12        }
13      }
14    }
15  },
16  "caseInfo": {
17    "data": {
18      "Origin": {
19        "value": "Web"
20      },
21      "Subject": {
22        "value": "what the Case is about"
23      }
24    }
25  },
26  "documentInfo": {
27    "data": [
28      {
29        "id": "content document id",
30        "typeId": "document type id",
31        "name": "document name"
32      }
33    ]
34  }
35}
36

JSON Examples

The attributes in this example are for an address update request.

1{
2  "svcCatalogItemDefApiName": "AddressUpdate",
3  "attributes": {
4    "data": {
5      "AddressLine1": {
6        "value": "6th main road"
7      },
8      "DoorNumber": {
9        "value": 123456
10      },
11      "GeoLocation": {
12        "value": {
13          "Latitude": 5,
14          "Longitude": 6
15        }
16      },
17      "FinancialAccounts": {
18        "value": [
19          {
20            "FinancialAccountNumber": 1111
21          },
22          {
23            "FinancialAccountNumber": 9999
24          }
25        ]
26      },
27      "UpdateCustomerShippingAddress": {
28        "value": true
29      },
30      "UpdateCustomerBillingAddress": {
31        "value": true
32      },
33      "EffectiveDate": {
34        "value": "2022-1-1"
35      }
36    }
37  },
38  "caseInfo": {
39    "data": {
40      "Origin": {
41        "value": "Web"
42      },
43      "Subject": {
44        "value": "Customer moved to a new residence"
45      }
46    }
47  },
48  "documentInfo": {
49    "data": [
50      {
51        "id": "a0IRO0000005dhq2AA",
52        "typeId": "License",
53        "name": "Driver’s license"
54      }
55    ]
56  }
57}
58

The attributes in this example are for a fee reversal request.

1{
2  "attributes": {
3    "data": {
4      "financial_account_id_1": {
5        "value": "accountId"
6      },
7      "source_system_id_1": {
8        "value": "100"
9      },
10      "reversal_reason_1": {
11        "value": null
12      },
13      "fee_reversal_transactions_1": {
14        "value": [
15          {
16            "frt_transaction_id_1": "12",
17            "frt_transaction_posted_date_1": "2022-11-11T12:53:14.924Z",
18            "frt_transaction_amount_1": 50,
19            "frt_transaction_amount_currency_1": "USD",
20            "frt_fee_type_1": "Check book charge",
21            "frt_transaction_code_1": "54",
22            "frt_reversal_amount_currency_1": null,
23            "frt_reversal_amount_1": null,
24            "frt_reversal_percentage_1": null,
25            "frt_override_amount_currency_1": null,
26            "frt_override_amount_1": null,
27            "frt_override_percentage_1": null,
28            "frtr_transaction_id_1": null,
29            "frtr_transaction_posted_date_1": null,
30            "frtr_transaction_description_1": null,
31            "frtr_transaction_amount_1": null,
32            "frtr_transaction_amount_currency_1": null,
33            "frtr_error_reason_1": null
34          }
35        ]
36      },
37      "reversal_summary_1": {
38        "value": {
39          "reversal_transaction_status_1": null
40        }
41      }
42    }
43  },
44  "svcCatalogItemDefApiName": "Fee_Reversal_Test_2",
45  "caseInfo": {
46    "data": {
47      "Subject": {
48        "value": "Check book charge reversal"
49      },
50      "Origin": {
51        "value": "Phone"
52      }
53    }
54  }
55}
56

Properties

Name	Type	Description	Required or Optional	Available Version
svcCatalogItemDefApiName	String	The Service Process definition in Setup that specifies the attributes.	Required	57.0
attributes:data	Map<String, Object>	Values for the attributes defined in the Service Process definition.	Required	57.0
caseInfo:data	Map<String, Object>	Field values for the Case object. Origin is required. For a POST request, don’t set the Id field.	Required	57.0
documentInfo:data	Map<String, Object>	The Id, name, and type of one or more documents associated with the Case.	Optional	57.0

Response Body for GET

JSON Format

1{
2  "attributes": {
3    "data": {
4      "AttrName1": {
5        "value": "some text"
6      },
7      "AttrName2": {
8        "value": {
9          "Value1": 123,
10          "Value2": 456
11        }
12      }
13    }
14  },
15  "caseId": "500xx000000brazAAA",
16  "caseNumber": "00001168",
17  "svcCatalogItemDefApiName": "0j2xx0000000001AAA",
18  "svcCatalogRequestId": "946xx0000004EkKAAU"
19}
20

JSON Example

The attributes in this example are for an address update request.

1{
2  "attributes": {
3    "data": {
4      "FinancialAccounts": {
5        "value": [
6          {
7            "FinancialAccountNumber": 1111
8          },
9          {
10            "FinancialAccountNumber": 9999
11          }
12        ]
13      },
14      "AddressLine1": {
15        "value": "1st main road"
16      },
17      "DoorNumber": {
18        "value": 1111.0
19      },
20      "GeoLocation": {
21        "value": {
22          "Latitude": 1.0,
23          "Longitude": 2.0
24        }
25      }
26    }
27  },
28  "caseId": "500xx000000brazAAA",
29  "caseNumber": "00001168",
30  "processDefinitionId": "0j2xx0000000001AAA",
31  "svcCatalogRequestId": "946xx0000004EkKAAU"
32}
33

Properties

Name	Type	Description	Available Version
attributes:data	Map<String, Object>	Values for the attributes defined in the Service Process definition.	57.0
caseId	String	The Case ID.	57.0
caseNumber	String	The Case number.	57.0
svcCatalogItemDefApiName	String	The Service Process definition in Setup that specifies the attributes.	57.0
svcCatalogRequestId	String	The svcCatalogRequestId used in the GET URI.	57.0

Response Body for POST

JSON Example, Success

1{
2  "caseId": "500xx000000bu4DAAQ",
3  "caseNumber": "00001182",
4  "svcCatalogRequestId": "946xx0000004FLQAA2"
5}
6

JSON Example, Failure

1{
2  "HttpCode": 404,
3  "ErrorCode": "DEFINITION_NOT_FOUND",
4  "Message": "Unable to find the service request definition id."
5}
6

HTTP Response Codes

HttpCode	ErrorCode	Message
400	VALIDATION_FAILURE	`AttrName1`, `AttrName2` is/are missing and/or doesn't match the contract. Please check the payload and retry.
401	SESSION_NOT_AUTHENTICATED	We are not able to authenticate your session. Please login and retry.
403	SESSION_NOT_AUTHORIZED	We are not able to authorize your session. Please login and retry.
404	DEFINITION_NOT_FOUND	Unable to find the service request definition id.

Industries Common Resources Developer Guide

Service Catalog