# Transactions

#Available from v.3.7.0 Every change in is recorded in a transaction. Use the transaction endpoints to get information on transactions and changes to entities within each of these.

GET /transactions/{entityType}/{entityId}/revisiondata Get an entity's changes

Request parameters

Property name Parameter type Data type Description
entityType path string

Type of entity (Can be Product, Variant, Category or GlobalListValue)

entityId path string

Id of entity

Response status OK (200)

array : ItemRevisionHistory
ItemRevisionHistory
Property name Data type Description
FieldName string
LastChange object : ItemRevisionChange
ItemRevisionChange array : ItemRevisionChange
ItemRevisionChange
Property name Data type Description
RevisionNo integer
RevisionValue string
ValueBefore string
Timestamp string
Username string
TransactionType string

GET /transactions/{uid} Get a specific transaction

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of transaction

Response status OK (200)

object : TransactionModel
TransactionModel
Property name Data type Description
Uid string

Unique id of the transaction

TransactionType string

Description of the type of transaction

Username string

Username of the user who performed the transaction

StartTimestamp string

The timestamp when the transaction was started

CommitTimestamp string

The timestamp when the transaction was committed


GET /transactions/{uid}/changedentities Get entities changed in a specific transaction

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of transaction to get changes for

entityTypes query string

Comma separated list of entity types to return (valid entity types are Category, Product, Variant, GlobalListValue)

Response status OK (200)

array : TransactionEntityModel
TransactionEntityModel
Property name Data type Description
EntityType string

Type of entity

EntityId string

The unique id of the entity

RevisionNo integer

The revision number assigned to the entity in this transaction

TransactionUid string

Unique id of the transaction


POST /transactions/batch Get a batch of transactions

Request parameters

Property name Parameter type Data type Description
uids body array : string

uids of transactions to return

Response status OK (200)

array : TransactionModel
TransactionModel
Property name Data type Description
Uid string

Unique id of the transaction

TransactionType string

Description of the type of transaction

Username string

Username of the user who performed the transaction

StartTimestamp string

The timestamp when the transaction was started

CommitTimestamp string

The timestamp when the transaction was committed


POST /transactions/batch/changedentities Get entities changed in a batch of transactions

A maximum of 5000 transactions can be fetched at a time

Request parameters

Property name Parameter type Data type Description
uids body array : string

Unique ids of transactions to get changes for

entityTypes query string

Comma separated list of entity types to return (valid entity types are Category, Product, Variant, GlobalListValue)

Response status OK (200)

array : TransactionEntityModel
TransactionEntityModel
Property name Data type Description
EntityType string

Type of entity

EntityId string

The unique id of the entity

RevisionNo integer

The revision number assigned to the entity in this transaction

TransactionUid string

Unique id of the transaction


GET /transactions/changes/{entityType}/{entityId}/{revisionNo} Get an entity's changes for in a specific revision

Request parameters

Property name Parameter type Data type Description
entityType path string

Type of entity (Can be Product, Variant, Category or GlobalListValue)

entityId path string

Id of entity

revisionNo path integer

Revision to get changes for

Response status OK (200)

array : EntityRevisionChangeModel
EntityRevisionChangeModel
Property name Data type Description
EntityType string

Type of entity

EntityId string

The unique id of the entity

RevisionNo integer

The revision number assigned to the entity in this transaction

DataType string

Reference to the type of data change that was made for this entity in this revision


POST /transactions/changes/batch Get revision changes for a batch of entities

Request parameters

Property name Parameter type Data type Description
requests body array : EntityRevisionChangeRequestModel

Entities and revisions to get changes for

EntityRevisionChangeRequestModel
Property name Data type Description
EntityType string

Type of entity

EntityId string

Unique id of entity

RevisionNo integer

Revision number

Response status OK (200)

array : EntityRevisionChangeModel
EntityRevisionChangeModel
Property name Data type Description
EntityType string

Type of entity

EntityId string

The unique id of the entity

RevisionNo integer

The revision number assigned to the entity in this transaction

DataType string

Reference to the type of data change that was made for this entity in this revision


GET /transactions/search Search transactions. Returns paged result set with a page size of 1000

Request parameters

Property name Parameter type Data type Description
page query integer

Page to return results for (1 is first page)

fromTimestamp query string

Query transactions committed after this timestamp

toTimestamp query string

Query transactions committed before this timestamp

username query string

Query transactions made by this username

Response status OK (200)

array : TransactionModel
TransactionModel
Property name Data type Description
Uid string

Unique id of the transaction

TransactionType string

Description of the type of transaction

Username string

Username of the user who performed the transaction

StartTimestamp string

The timestamp when the transaction was started

CommitTimestamp string

The timestamp when the transaction was committed