External IDs

The External IDs object contains a set of external identifiers.

External IDs are assigned during a PUT (update) or POST (create) request. Clients can update only their own External IDs, Vendors can update only their own External IDs, and SoftwareOne Operations can update only the ID related to their specific operation.

Field	Type	Description
externalIds.client	string	The client-specific external ID, visible to clients.
externalIds.operations	string	The operations-specific external Id, visible to operations.
externalIds.vendor	string	The vendor-specific external Id, visible for vendors.

Example

EXTERNAL ID OBJECT

{
  "client": "12345678",
  "operations":	"07bf766b-c767-4293-9ab3",
  "vendor": "ABC-2023-C07-dbeee0b302c0"
}

Semantics and typical usage

Many resources (agreements, orders, subscriptions, etc.) expose an externalIds property. It stores key identifiers from actors that interact with the object but are not part of the marketplace (vendor, client, operations). Each actor can set and see only their own key; the meaning of each key depends on the resource and the actor.

• externalIds.vendor — On agreements and related resources, the vendor often stores the external unique identifier of the contract in their system (e.g. Microsoft account ID, Adobe client ID). Use it to correlate platform objects with vendor-side contracts or systems.

• externalIds.client — The client can use this for programmatic access or to store a reference that matters on their side (e.g. blanket order ID, open order ID, or an internal reference). Useful when looking up an order or agreement "by our reference" or "by our ID".

• externalIds.operations — Used by SoftwareOne operations for their own identifiers and processes.

Which keys exist and who can read/write them depends on the resource and the caller; check the resource schema and visibility rules. To filter by an external ID in RQL, use the field path (e.g. eq(externalIds.vendor,"ABC-123") or eq(externalIds.client,"my-ref-456")) when the resource exposes it.