v15

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-011631130.4 KB

Management

Start Installation

Starts the installation workflow and stores the initial execution state.

post/installation

Headers

x-gw-ims-org-idstring required

Adobe IMS organization ID that identifies the organization for the request.

Request body

commerceBaseUrlstring required

commerceEnv'paas' | 'saas' required

ioEventsUrlstring required

ioEventsEnvstring required

Response

The installation workflow was accepted and queued for asynchronous execution.

messagestring required

activationIdstring required

idstring required

status'in-progress' required

startedAtstring date-time required

configobject

The validated app configuration recorded at install time. Present so uninstallation can be sourced from what was actually installed rather than the current request config. Absent on states persisted before this field was introduced.

dataobject nullable required