Create Bundle
Add a Remote Site
1. From Setup, in the Quick Find box, enter Security, and then select Remote Site Settings.
2. Click New Remote Site.
3. Enter a name.
4. For Remote Site URL, enter https://api.salesforce.com/
5. Save your changes.
- URI
- <host>/bundleflow/api/v1.0/bundle
- Format
- JSON
- HTTP Method
- POST
- Authentication
-
Authorization: Bearer
<token>
If the authentication token isn’t valid, a 401 HTTP status is returned.
- Headers
- request.setHeader('x-sfdc-tenant-id', 'core/prod/ORG-ID_18_Characters');—Field Service functional domain
- sf_api_version—Salesforce API version. Minimum version is 53.0.
- Authorization—Authorization token.
- Content-Type—File format. Valid value is JSON.
- Referer—Org domain URL.
Request Body
Properties
Field | Type | Description | ||
---|---|---|---|---|
user | String | Optional. User name of user sending the request. | ||
initiate | String | Type of bundle request. Valid value: manual |
||
bundlePolicyId | String | ID of the related bundle policy containing the bundling rules. | ||
saRequestPayloads | Array | Details of service appointments that are bundled. | ||
serviceAppointmentId | String | ID of service appointments to be bundled. | ||
action | String | Bundling action performed on this service appointment. Valid value: add |
Example
JSON Example
This example shows a manual bundle request of two service appointments.
{
"user": "Misha1",
"initiate": "manual",
"bundlePolicyId": "7sTx00000000006EAA",
"saRequestPayloads": [
{
"serviceAppointmentId": "08px000000NzbmsAAB",
"action": "add"
},
{
"serviceAppointmentId": "08pT300000006LLIAY",
"action": "add"
}
]
}
Response Body
Properties
Field | Type | Description | ||
---|---|---|---|---|
bundleId | String | ID of the new bundle. If the bundle isn’t created, this field is null. | ||
responsePayloads | Array | Details of the bundled objects. | ||
objectName | String | Type of object. Output: ServiceAppointment |
||
objectId | String | ID of the service appointment. | ||
action | String | Action performed on the object. | ||
status | String | Specifies if this object is bundled correctly. Output: SUCCESS or FAIL |
||
messageCode | Number | Success or error code of bundling the service appointment. 0 means success. The error codes are listed in Error Responses. | ||
message | String | Success or error message of bundling the object. | ||
status | String | Status of the request. Output: SUCCESS or FAIL |
||
messageCode | Number | Success or error code of the request. 0 means success. The error codes are listed in Error Responses. | ||
message | String | Success or error message of the request. | ||
messageAdditionalInfo | String | More information provided by Salesforce. |
Example
JSON Example: Successful Response
This example shows the output of two service appointments bundled successfully.
{
"bundleId": "08px000000NzdH8AAJ",
"responsePayloads": [
{
"objectName": "ServiceAppointment",
"objectId": "08px000000NzbmsAAB",
"action": "add",
"status": "SUCCESS",
"messageCode": "NONE",
"message": "Success",
"messageParams": [
]
},
{
"objectName": "ServiceAppointment",
"objectId": "08pT300000006LLIAY",
"action": "add",
"status": "SUCCESS",
"messageCode": "NONE",
"message": "Success",
"messageParams": [
]
}
],
"status": "SUCCESS",
"messageCode": "NONE",
"message": "Success"
}
Example
JSON Example: Fail Response
This example shows the output of a request that’s trying to bundle a service appointment that’s already a bundle service appointment. A service appointment can’t be part of two bundles, so the response status is FAIL.
{
"bundleId":null,
"responsePayloads":[
{
"objectName":"ServiceAppointment",
"objectId":"08px000000NzdH8AAJ",
"action":"add",
"status":"FAIL",
"messageCode":"SA_ALREADY_BUNDLED",
"message":"Is already a bundle service appointment.",
"messageParams":[
]
}
],
"status":"FAIL",
"messageCode":"ERROR_CREATING_BUNDLE",
"message":"We couldn't bundle the service appointment.",
"messageAdditionalInfo": ""
}
Code | Name | Message |
---|---|---|
0 | NONE | <Service Appointment ID#>: Success. |
1 | UNSUPPORTED_VERSION | Ask your admin to check the API version, then try again. |
2 | SA_PAYLOAD_SHOULD_CONTAIN_ADD_ACTIONS_ONLY | Create bundles using add actions only. |
3 | EMPTY_BUNDLE_POLICY | Enter an ID for the bundlePolicyId. |
4 | EMPTY_BUNDLE_INITIATE | Specify manual or auto for the initiate entry. |
5 | EMPTY_BUNDLE_SERVICE_APPOINTMENT | Add a bundle service appointment. |
6 | SA_PAYLOAD_DUPLICATED_SAS | Remove duplicate service appointment IDs. |
7 | SA_IS_BUNDLE | <Service Appointment ID#>: Is already a bundle service appointment. |
8 | SA_ALREADY_BUNDLED | <Service Appointment ID#>: Is a bundle member service appointment in another bundle. |
9 | STATUS_FORBIDDEN | <Service Appointment ID#>: Can’t be bundled in the current status. |
10 | SA_PAYLOAD_SHOULD_NOT_CONTAIN_MIX_ACTIONS | Send separate requests for add and remove actions. |
11 | SA_IS_NOT_BUNDLE | Select a bundle service appointment and try again. |
12 | EXCEEDED_BUNDLE_MEMBERS_LIMIT | You reached the maximum number of service appointments for this bundle. Remove some of them and try again. |
13 | SA_PAYLOAD_SHOULD_CONTAIN_ONLY_BUNDLE_MEMBERS | To remove bundle members from a bundle, include only service appointments that are bundle members. |
14 | ERROR_IN_BASIC_VALIDATIONS | We couldn’t bundle the service appointments. |
15 | ERROR_IN_LIMIT_VALIDATIONS | N/A |
16 | ERROR_IN_CRITERIA_VALIDATIONS | N/A |
17 | ERROR_IN_SERVICE_TERRITORY_VALIDATIONS | Confirm or revise the service territories of the selected service appointments. Or ask your admin for help. |
18 | ERROR_IN_RESTRICTION_VALIDATIONS | Confirm or revise the selected service appointments. Or ask your admin to check the restriction policies. |
19 | EXCEEDED_BUNDLE_DURATION_LIMIT | N/A |
20 | EMPTY_BODY | Fill in the request. |
21 | SA_IS_NOT_BUNDLED | <Service Appointment ID#>: Can’t remove a service appointment that isn’t in the bundle. |
22 | ERROR_IN_AGGREGATION | Confirm or revise the selected service appointments. Or ask your admin to check the aggregation policies. |
23 | ERROR_IN_PROPAGATION | Confirm or revise the selected service appointments. Or ask your admin to check the propagation policies. |
24 | GET_POLICY_FAILURE | Ask your admin to check the bundle policies, then try again. |
25 | GET_CONFIG_FAILURE | Ask your admin to check the bundle config, then try again. |
26 | GET_BUNDLE_INFO_FAILURE | Try again later. |
27 | ERROR_IN_LOGIC | We couldn’t bundle the service appointments. |
28 | EMPTY_BUNDLE_MEMBERS | Add bundle member service appointments. |
29 | EMPTY_BUNDLE_PARENT_WORK_ORDER_ID | Add the work order ID for the bundle service appointment. |
30 | UNBUNDLE_REQUEST_ASSIGNED_RESOURCES_NOT_COMPATiBLE | To unbundle a scheduled bundle, send assigned resources for each service appointment. |
31 | EMPTY_OLD_VALUES | To update a bundle, send the current values. |
32 | EMPTY_NEW_VALUES | To update a bundle, send the new values. |
33 | SA_PAYLOAD_SHOULD_CONTAIN_AT_LEAST_ONE_ADD_OR_REMOVE_ACTION | To update a bundle, send at least one add or remove action. |
34 | FORBIDDEN_FIELDS_IN_POLICY_OBJECT | Confirm or revise the selected service appointments. Or ask your admin to check the field names selected in the related policies. |
35 | EMPTY_SERVICE_TERRITORY | Add a Service Territory ID. |
36 | EMPTY_START_TIME | Add the interval’s start time. |
37 | EMPTY_END_TIME | Add the interval’s end time. |
38 | ERROR_IN_BUNDLE_POLICY_RFC | Confirm or revise the selected service appointments. Or ask your admin to check the recordset filter criteria in the bundle policy. |
39 | ERROR_IN_TIME_ZONE_VALIDATION | Select service appointments that are in the same time zone. Or ask your admin for help. |
40 | ERROR_IN_LOGIC_UNBUNDLE | We couldn’t unbundle the service appointment. |
41 | ERROR_CREATING_BUNDLE | We couldn’t bundle the service appointments. |
42 | ERROR_ADDING_TO_BUNDLE | We couldn’t add the service appointment to the bundle. |
43 | ERROR_REMOVING_FROM_BUNDLE | We couldn’t remove the service appointment from the bundle. |
44 | ERROR_UNBUNDLING | We couldn’t unbundle the service appointment. |
58 | ERROR_IN_MSW_VALIDATIONS | We can’t bundle service appointments with dependencies. Remove the dependencies and try again. |
-500 | http error | Hmm… Something went wrong. Try again. |
Code Sample from Apex
public static Map<String, String> createSABundle() {
String apiVersion = '54.0'; // Spring '22
String bundleApi = '/bundleflow/api/v1.0/bundle';
String host = {Namespace}.BundleLogic.getBundlerFalconEnvironment();
String ref = URL.getOrgDomainUrl().toExternalForm();
String bundleService = host + bundleApi;
// Create HTTP request
HttpRequest request = new HttpRequest();
request.setEndpoint(bundleService);
request.setMethod('POST');
request.setHeader('sf_api_version', apiVersion);
request.setHeader('Content-Type', 'application/json' );
// NOTE: This user must have 'Field Service Integration' permissions.
request.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionId());
request.setHeader('Referer', ref);
request.setHeader('x-sfdc-tenant-id', 'core/prod/ORG-ID_18_Characters');
request.setTimeout(120000);
// Create the body
Map<String, Object> body = new Map<String, Object>();
body.put('initiate','manual');
body.put('bundlePolicyId','7sT9A0000004DX6UAM'); // NOTE: Use a real bundle policy ID.
Map<String, Object> saList = new Map<String, Object>();
saList.put('serviceAppointmentId', '08p9A0000005LEGQA2'); // NOTE: Use a real Service Appointment ID.
saList.put('action', 'add');
List<Object> objectsList = new List<Object>();
objectsList.add(saList);
body.put('saRequestPayloads', objectsList);
String reqBody = JSON.serialize(body);
System.debug(body);
request.setBody(reqBody);
HttpResponse response = new Http().send(request);
// Parse the JSON response
// Handle a redirect message
while (response.getStatusCode() == 302) {
request.setEndpoint(response.getHeader('Location'));
response = new Http().send(request);
}
Map<String, String> returnValue = new Map<String, String>();
returnValue.put('statusCode', String.valueOf(response.getStatusCode()));
// Return value when we don't get a success response
if (response.getStatusCode() != 200) {
returnValue.put('message', 'The status code returned was not expected: ' + response.getStatusCode() + ' ' + response.getStatus());
System.debug(returnValue.get('message'));
return (returnValue);
// Return value when we do get a success response
} else {
returnValue.put('message', response.getBody());
System.debug(response.getBody());
return (returnValue);
}
}
Map<String, String> response = createSABundle();
System.debug(response);