---
title: "Get Commerce App Configuration"
method: GET
path: "/app-config"
tags: ["App Metadata"]
---

# Get Commerce App Configuration

`GET /app-config`

Returns the Commerce App configuration after resolving and validating it against the schema. When `commerceEnv` is provided, webhooks and events are filtered to that Commerce environment; when omitted, the full, unfiltered configuration is returned.

## Query parameters

- `commerceEnv` 'paas' | 'saas'

## Headers

- `x-gw-ims-org-id` string, required

## Response `200`

The resolved and validated Commerce App configuration.

- object — Current app configuration
  - `metadata` object, required
    - `id` string, required
    - `displayName` string, required
    - `description` string, required
    - `version` string, required
  - `businessConfig` object
    - `schema` union[]
      - union
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'list', required
          - `options` object[], required
            - `label` string, required
            - `value` string, required
          - `selectionMode` 'single', required
          - `default` string, required
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'list', required
          - `options` object[], required
            - `label` string, required
            - `value` string, required
          - `selectionMode` 'multiple', required
          - `default` string[], required
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'text', required
          - `default` string, required
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'password', required
          - `default` '', required
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'email', required
          - `default` union, required
            - ''
            - string, email
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'url', required
          - `default` union, required
            - ''
            - string, uri
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'tel', required
          - `default` union, required
            - ''
            - string
        - object
          - `name` string, required
          - `label` string
          - `description` string
          - `env` string[]
          - `type` 'boolean', required
          - `default` boolean, required
  - `eventing` object
    - `commerce` object[]
      - `provider` EventProvider, required
        - `label` string, required
        - `description` string, required
        - `key` string
      - `events` object[], required
        - `label` string, required
        - `description` string, required
        - `runtimeActions` string[], required
        - `name` string, required
        - `fields` CommerceEventField[], required
          - `name` string, required
          - `source` string
        - `rules` CommerceEventRule[]
          - `field` string, required
          - `operator` 'greaterThan' | 'lessThan' | 'equal' | 'regex' | 'in' | 'onChange', required
          - `value` string, required
        - `destination` string
        - `hipaa_audit_required` boolean
        - `priority` boolean
        - `force` boolean
    - `external` object[]
      - `provider` EventProvider, required
        - `label` string, required
        - `description` string, required
        - `key` string
      - `events` object[], required
        - `label` string, required
        - `description` string, required
        - `runtimeActions` string[], required
        - `name` string, required
  - `adminUi` AdminUiConfiguration
    - `menu` AdminUiMenu
      - `id` string, required
      - `label` string, required
      - `description` string, required
      - `pageTitle` string
      - `parentMenu` 'sales' | 'catalog' | 'customers' | 'marketing' | 'content' | 'reports' | 'stores' | 'system'
      - `sandboxPermissions` string[]
    - `order` object
      - `massActions` AdminUiMassAction[]
        - union
          - object
            - `id` string, required
            - `label` string, required
            - `type` 'view', required
            - `path` string, required
            - `title` string
            - `description` string
            - `confirm` AdminUiConfirm
              - …
            - `notifications` AdminUiNotifications
              - …
            - `selectionLimit` number
            - `sandboxPermissions` string[]
          - object
            - `id` string, required
            - `label` string, required
            - `type` 'worker', required
            - `runtimeAction` string, required
            - `title` string
            - `description` string
            - `confirm` AdminUiConfirm
              - …
            - `notifications` AdminUiNotifications
              - …
            - `selectionLimit` number
            - `timeout` number
      - `gridColumns` AdminUiGridColumns
        - `label` string, required
        - `description` string, required
        - `runtimeAction` string, required
        - `columns` object[], required
          - `id` string, required
          - `label` string, required
          - `type` 'boolean' | 'date' | 'datetime' | 'float' | 'integer' | 'string', required
          - `align` 'left' | 'right' | 'center', required
      - `viewButtons` AdminUiOrderViewButton[]
        - union
          - object
            - `type` 'view', required
            - `id` string, required
            - `label` string, required
            - `description` string
            - `path` string, required
            - `level` -1 | 0 | 1
            - `sortOrder` number
            - `confirm` AdminUiConfirm
              - …
            - `sandboxPermissions` string[]
            - `notifications` AdminUiNotifications
              - …
          - object
            - `type` 'worker', required
            - `id` string, required
            - `label` string, required
            - `description` string
            - `runtimeAction` string, required
            - `level` -1 | 0 | 1
            - `sortOrder` number
            - `confirm` AdminUiConfirm
              - …
            - `timeout` number
            - `notifications` AdminUiNotifications
              - …
    - `product` object
      - `massActions` AdminUiMassAction[]
        - union
          - object
            - `id` string, required
            - `label` string, required
            - `type` 'view', required
            - `path` string, required
            - `title` string
            - `description` string
            - `confirm` AdminUiConfirm
              - …
            - `notifications` AdminUiNotifications
              - …
            - `selectionLimit` number
            - `sandboxPermissions` string[]
          - object
            - `id` string, required
            - `label` string, required
            - `type` 'worker', required
            - `runtimeAction` string, required
            - `title` string
            - `description` string
            - `confirm` AdminUiConfirm
              - …
            - `notifications` AdminUiNotifications
              - …
            - `selectionLimit` number
            - `timeout` number
      - `gridColumns` AdminUiGridColumns
        - `label` string, required
        - `description` string, required
        - `runtimeAction` string, required
        - `columns` object[], required
          - `id` string, required
          - `label` string, required
          - `type` 'boolean' | 'date' | 'datetime' | 'float' | 'integer' | 'string', required
          - `align` 'left' | 'right' | 'center', required
    - `customer` object
      - `massActions` AdminUiMassAction[]
        - union
          - object
            - `id` string, required
            - `label` string, required
            - `type` 'view', required
            - `path` string, required
            - `title` string
            - `description` string
            - `confirm` AdminUiConfirm
              - …
            - `notifications` AdminUiNotifications
              - …
            - `selectionLimit` number
            - `sandboxPermissions` string[]
          - object
            - `id` string, required
            - `label` string, required
            - `type` 'worker', required
            - `runtimeAction` string, required
            - `title` string
            - `description` string
            - `confirm` AdminUiConfirm
              - …
            - `notifications` AdminUiNotifications
              - …
            - `selectionLimit` number
            - `timeout` number
      - `gridColumns` AdminUiGridColumns
        - `label` string, required
        - `description` string, required
        - `runtimeAction` string, required
        - `columns` object[], required
          - `id` string, required
          - `label` string, required
          - `type` 'boolean' | 'date' | 'datetime' | 'float' | 'integer' | 'string', required
          - `align` 'left' | 'right' | 'center', required
  - `installation` object
    - `messages` object
      - `preInstallation` string
      - `postInstallation` string
    - `customInstallationSteps` object[]
      - `script` string, required
      - `name` string, required
      - `description` string, required
  - `webhooks` union[]
    - union
      - RuntimeActionWebhookConfig
        - `label` string, required
        - `description` string, required
        - `category` 'validation' | 'append' | 'modification'
        - `runtimeAction` string, required
        - `requireAdobeAuth` boolean
        - `webhook` WebhookDefinition, required
          - `webhook_method` string, required
          - `webhook_type` string, required
          - `batch_name` string, required
          - `batch_order` number
          - `hook_name` string, required
          - `priority` number
          - `required` boolean
          - `soft_timeout` number
          - `timeout` number
          - `method` string, required
          - `fallback_error_message` string
          - `ttl` number
          - `fields` WebhookField[]
            - `name` string, required
            - `source` string
          - `rules` WebhookRule[]
            - `field` string, required
            - `operator` string, required
            - `value` string, required
          - `headers` WebhookHeader[]
            - `name` string, required
            - `value` string, required
      - ExternalUrlWebhookConfig
        - `label` string, required
        - `description` string, required
        - `category` 'validation' | 'append' | 'modification'
        - `webhook` object, required
          - `webhook_method` string, required
          - `webhook_type` string, required
          - `batch_name` string, required
          - `batch_order` number
          - `hook_name` string, required
          - `priority` number
          - `required` boolean
          - `soft_timeout` number
          - `timeout` number
          - `method` string, required
          - `fallback_error_message` string
          - `ttl` number
          - `fields` WebhookField[]
            - `name` string, required
            - `source` string
          - `rules` WebhookRule[]
            - `field` string, required
            - `operator` string, required
            - `value` string, required
          - `headers` WebhookHeader[]
            - `name` string, required
            - `value` string, required
          - `url` string, uri, required
  - `openApiSpecUrl` string, uri, required — URL of the OpenAPI spec for this deployment, scoped to the active capabilities. Includes a content-addressed cache key as a query parameter.

## Other responses

- `401` — You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid.
- `403` — The access token is valid, but it is not allowed to access the requested organization or operation.
- `500` — An unexpected server error occurred.

---

[API](https://skmtc.net/adobe/apis/app-management-api.md) · [All operations](https://skmtc.net/adobe/apis/app-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adobe/app-management-api/versions/5a327358e0ba/schema)