commercetools · Schema

Change

A single field-level change within a change history record.

CommerceComposable CommerceE-CommerceGraphQLRESTSDK

Properties

Name Type Description
change string The name of the update action that caused this change (e.g., 'setCustomField', 'changeOrderState').
type string The type identifier of this change entry.
previousValue object The field value before the change was applied.
nextValue object The field value after the change was applied.
View JSON Schema on GitHub

JSON Schema

commercetools-change-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Change",
  "title": "Change",
  "type": "object",
  "description": "A single field-level change within a change history record.",
  "required": [
    "change",
    "type"
  ],
  "properties": {
    "change": {
      "type": "string",
      "description": "The name of the update action that caused this change (e.g., 'setCustomField', 'changeOrderState')."
    },
    "type": {
      "type": "string",
      "description": "The type identifier of this change entry."
    },
    "previousValue": {
      "description": "The field value before the change was applied."
    },
    "nextValue": {
      "description": "The field value after the change was applied."
    }
  }
}