curl --request POST \
--url https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"purchaseActivities": [
{
"purchaseActivityIds": [
"a0B5g00000PA1AAA",
"a0B5g00000PA2AAA"
]
},
{
"purchaseActivityIds": [
"a0B5g00000PA3AAA"
]
}
]
}
'import requests
url = "https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal"
payload = { "purchaseActivities": [{ "purchaseActivityIds": ["a0B5g00000PA1AAA", "a0B5g00000PA2AAA"] }, { "purchaseActivityIds": ["a0B5g00000PA3AAA"] }] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
purchaseActivities: [
{purchaseActivityIds: ['a0B5g00000PA1AAA', 'a0B5g00000PA2AAA']},
{purchaseActivityIds: ['a0B5g00000PA3AAA']}
]
})
};
fetch('https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'purchaseActivities' => [
[
'purchaseActivityIds' => [
'a0B5g00000PA1AAA',
'a0B5g00000PA2AAA'
]
],
[
'purchaseActivityIds' => [
'a0B5g00000PA3AAA'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal"
payload := strings.NewReader("{\n \"purchaseActivities\": [\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA1AAA\",\n \"a0B5g00000PA2AAA\"\n ]\n },\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA3AAA\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"purchaseActivities\": [\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA1AAA\",\n \"a0B5g00000PA2AAA\"\n ]\n },\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA3AAA\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"purchaseActivities\": [\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA1AAA\",\n \"a0B5g00000PA2AAA\"\n ]\n },\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA3AAA\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"errors": [
"<string>"
],
"results": [
{
"purchaseActivityIds": [
"<string>"
],
"renewalOrderId": "<string>",
"purchaseActivityIdToErrorMessage": {}
}
]
}{
"results": [
{
"purchaseActivityIds": [
"a0B5g00000PA1AAA",
"a0B5g00000PA2AAA"
],
"renewalOrderId": "8015g00000RenewalAAA",
"purchaseActivityIdToErrorMessage": {}
}
],
"success": true
}{
"success": false,
"errors": [
"businessUnitId is required"
]
}Generate renewal orders
Generates renewal orders from one or more sets of Purchase Activity Ids. Each entry in purchaseActivities corresponds to a single renewal order; all the Purchase Activity Ids inside a single set are rolled up into that one renewal order. Internally fires the GenerateRenewalOrder Service Layer event.
curl --request POST \
--url https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"purchaseActivities": [
{
"purchaseActivityIds": [
"a0B5g00000PA1AAA",
"a0B5g00000PA2AAA"
]
},
{
"purchaseActivityIds": [
"a0B5g00000PA3AAA"
]
}
]
}
'import requests
url = "https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal"
payload = { "purchaseActivities": [{ "purchaseActivityIds": ["a0B5g00000PA1AAA", "a0B5g00000PA2AAA"] }, { "purchaseActivityIds": ["a0B5g00000PA3AAA"] }] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
purchaseActivities: [
{purchaseActivityIds: ['a0B5g00000PA1AAA', 'a0B5g00000PA2AAA']},
{purchaseActivityIds: ['a0B5g00000PA3AAA']}
]
})
};
fetch('https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'purchaseActivities' => [
[
'purchaseActivityIds' => [
'a0B5g00000PA1AAA',
'a0B5g00000PA2AAA'
]
],
[
'purchaseActivityIds' => [
'a0B5g00000PA3AAA'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal"
payload := strings.NewReader("{\n \"purchaseActivities\": [\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA1AAA\",\n \"a0B5g00000PA2AAA\"\n ]\n },\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA3AAA\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"purchaseActivities\": [\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA1AAA\",\n \"a0B5g00000PA2AAA\"\n ]\n },\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA3AAA\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.my.salesforce.com/services/apexrest/v1/orderRenewal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"purchaseActivities\": [\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA1AAA\",\n \"a0B5g00000PA2AAA\"\n ]\n },\n {\n \"purchaseActivityIds\": [\n \"a0B5g00000PA3AAA\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"errors": [
"<string>"
],
"results": [
{
"purchaseActivityIds": [
"<string>"
],
"renewalOrderId": "<string>",
"purchaseActivityIdToErrorMessage": {}
}
]
}{
"results": [
{
"purchaseActivityIds": [
"a0B5g00000PA1AAA",
"a0B5g00000PA2AAA"
],
"renewalOrderId": "8015g00000RenewalAAA",
"purchaseActivityIdToErrorMessage": {}
}
],
"success": true
}{
"success": false,
"errors": [
"businessUnitId is required"
]
}Authorizations
Salesforce session ID (or OAuth 2.0 access token issued by the Salesforce org) supplied as Authorization: Bearer <token>. Obtain via the Salesforce OAuth 2.0 flows or the SOAP login API.
Body
One entry per renewal order to generate. Each entry's purchaseActivityIds are rolled up into a single renewal order.
1Show child attributes
Show child attributes
Response
Renewal request processed but one or more sets failed; check results[*].purchaseActivityIdToErrorMessage and the top-level success/errors fields.
Common envelope returned by every endpoint. Concrete responses extend this shape with operation-specific fields.

