Skip to main content
POST
Generate renewal orders

Authorizations

Authorization
string
header
required

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

application/json
purchaseActivities
object[]
required

One entry per renewal order to generate. Each entry's purchaseActivityIds are rolled up into a single renewal order.

Minimum array length: 1

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.

success
boolean

true when the request completed without errors.

errors
string[]

Populated with one or more error messages when success is false.

results
object[]

One result per input purchaseActivities entry.