Audit Log now supports Stores

24 March 2022

Composable Commerce

HTTP API

Enhancement

Audit LogProject configuration

We have extended the abilities of Audit Log to include tracking of changes on Stores as well as on Store-related information on Customers, Orders, and Shopping Lists.

For supported resources, this enhancement will now scope Audit Log response data to the user's or API Client's Store permissions. All other resources will remain unaffected.

Changes:

[API] Adds stores attribute to Record response.
[API] Adds filter for store keys to all available endpoints.
[GraphQL API] Adds stores attribute to ChangeHistory type.
[GraphQL API] Adds filter for store keys to all queries for supported resources.

The following change was introduced in terms of GraphQL SDL:


type Store {
  key: String!
  typeId: String!
}

type ChangeHistory {
  version: Int!
  previousVersion: Int!
  stores: [Store!]!
  type: ChangeType!
  modifiedAt: String!
  modifiedBy: Initiator!
  resource: Resource!
  label: ResourceLabel!
  previousLabel: ResourceLabel!
  withoutChanges: Boolean
  changes: [Change]!
}

changeHistory(
  ...
  stores: [String!]
): ChangeHistoryQueryResults!

customers(
  ...
  stores: [String!]
): ChangeHistoryQueryResults!

customer(
  ...
  stores: [String!]
): ChangeHistoryQueryResults!

orders(
  ...
  stores: [String!]
): ChangeHistoryQueryResults!

order(
  ...
  stores: [String!]
): ChangeHistoryQueryResults!

shoppingLists(
  ...
  stores: [String!]
): ChangeHistoryQueryResults!

shoppingList(
  ...
  stores: [String!]
): ChangeHistoryQueryResults!