Installs

The Installs API surfaces the set of RORC lane installs that are accessible to the calling organization. An install represents a single store's registered RORCex deployment.

Install status reflects live agent connectivity (from CommerceStream) and credential configuration (from Identity) — it is not a RORC back-office read, nor is it served from the RORCex aggregate store. See Data Sources & Freshness.

---

List Installs

Return all installs that are within the calling organization's accessible scope.

GET /v1/installs

Authentication: OAuth Token (service_account or user) Permission: rorcex:installs.view

Response

{
  "data": [
    {
      "edge_agent_id": "eag_00000k1L2m3N4o5",
      "organization_hashkey": "org_00000k1L2m3N4o5",
      "connection_status": "online",
      "credential_status": "configured",
      "label": null
    }
  ]
}

Status: 200 OK

Response Fields

Field	Type	Description
edge_agent_id	string	Identifier of the CommerceEdge agent backing this install (eag_…).
organization_hashkey	string	Store organization hashkey for the install.
connection_status	string	Agent connectivity: online or offline.
credential_status	string	RORC back-office credential state: configured, incomplete, or not_configured.
label	string | null	Optional human-friendly label for the install.

Errors

See /reference/errors for authentication and authorization envelopes. This endpoint returns no install-specific errors — installs outside the caller's scope are silently excluded from the result set.

---

Get Install

Return the details of a single install by store organization hashkey.

GET /v1/installs/{orgHashkey}

Authentication: OAuth Token (service_account or user) Permission: rorcex:installs.view

Path Parameters

Parameter	Type	Required	Description
orgHashkey	string	Yes	Store organization hashkey (e.g., org_00000k1L2m3N4o5)

Response

{
  "edge_agent_id": "eag_00000k1L2m3N4o5",
  "organization_hashkey": "org_00000k1L2m3N4o5",
  "connection_status": "online",
  "credential_status": "configured",
  "label": null
}

The single-install response returns the install object directly (it is not wrapped in a data envelope). Fields are as documented in List Installs.

Status: 200 OK

Errors

404 — Install not found or out of scope:

{ "error": "not_found" }

This response is returned when no install exists for the given orgHashkey, or when the install exists but falls outside the calling organization's accessible scope.

See /reference/errors for authentication and authorization envelopes.