Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Transactions

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 a specific transaction

get
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired

Unique id of transaction

Responses
200

OK

application/json

A transaction represents a single unit of work in the system, in which one or more entities have been created, updated or deleted

Uidstring · uuidOptional

Unique id of the transaction

TransactionTypestring · nullableOptional

Description of the type of transaction

Usernamestring · nullableOptional

Username of the user who performed the transaction

StartTimestampstring · date-timeOptional

The timestamp when the transaction was started

CommitTimestampstring · date-timeOptional

The timestamp when the transaction was committed

get/v1/transactions/{uid}
GET /v1/transactions/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Uid": "bddab982-3c9f-4ef1-9167-7bec25746414",
  "TransactionType": "Product update",
  "Username": "support@struct.com",
  "StartTimestamp": "2021-10-20T12:56:27.2450000+02:00",
  "CommitTimestamp": "2021-10-20T12:56:27.3010000+02:00"
}

Get a batch of transactions

post
Authorizations
AuthorizationstringRequired
Bodystring · uuid[]
string · uuid[]Optional
Responses
200

OK

application/json

A transaction represents a single unit of work in the system, in which one or more entities have been created, updated or deleted

Uidstring · uuidOptional

Unique id of the transaction

TransactionTypestring · nullableOptional

Description of the type of transaction

Usernamestring · nullableOptional

Username of the user who performed the transaction

StartTimestampstring · date-timeOptional

The timestamp when the transaction was started

CommitTimestampstring · date-timeOptional

The timestamp when the transaction was committed

post/v1/transactions/batch
POST /v1/transactions/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 118

[
  "40464510-a518-4d86-b716-1dbdf7061fc2",
  "861360c4-82e4-4ec3-906c-200517c6dfc7",
  "9e3555f6-17ac-4ecd-b4de-82b6179192c0"
]
200

OK

[
  {
    "Uid": "cecf926f-9d55-497e-8fde-f656dd9b647d",
    "TransactionType": "Product update",
    "Username": "support@struct.com",
    "StartTimestamp": "2021-10-20T12:56:27.2450000+02:00",
    "CommitTimestamp": "2021-10-20T12:56:27.3010000+02:00"
  },
  {
    "Uid": "1b7d54de-d0ae-45bf-8608-b86099d38944",
    "TransactionType": "Variant update",
    "Username": "support@struct.com",
    "StartTimestamp": "2021-10-19T10:27:23.0750000+02:00",
    "CommitTimestamp": "2021-10-20T12:56:27.3220000+02:00"
  }
]

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

get
Authorizations
AuthorizationstringRequired
Query parameters
pageinteger · int32Optional

Page to return results for (1 is first page)

Default: 1
fromTimestampstring · date-timeOptional

Query transactions committed after this timestamp

toTimestampstring · date-timeOptional

Query transactions committed before this timestamp

usernamestringOptional

Query transactions made by this username

Responses
200

OK

application/json

Represents a result from a transaction search

TotalCountinteger · int32Optional

The total number of transactions contained in the search result

Pageinteger · int32Optional

The current page which results are returned for

get/v1/transactions/search
GET /v1/transactions/search HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "TotalCount": 2,
  "Page": 1,
  "Transactions": [
    {
      "Uid": "fe275653-2211-43be-8024-3cc35cd629e2",
      "TransactionType": "Product update",
      "Username": "support@struct.com",
      "StartTimestamp": "2021-10-20T12:56:27.2450000+02:00",
      "CommitTimestamp": "2021-10-20T12:56:27.3010000+02:00"
    },
    {
      "Uid": "6dd966a3-c4b4-48d6-81e4-a382d33744e1",
      "TransactionType": "Variant update",
      "Username": "support@struct.com",
      "StartTimestamp": "2021-10-19T10:27:23.0750000+02:00",
      "CommitTimestamp": "2021-10-20T12:56:27.3220000+02:00"
    }
  ]
}

Get an entity's changes

get
Authorizations
AuthorizationstringRequired
Path parameters
entityTypestringRequired

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

entityIdstringRequired

Id of entity

Responses
200

OK

application/json
FieldNamestring · nullableOptional
get/v1/transactions/{entityType}/{entityId}/revisiondata
GET /v1/transactions/{entityType}/{entityId}/revisiondata HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "FieldName": "Name (Danish)",
    "LastChange": {
      "RevisionNo": 2,
      "RevisionValue": "Test2",
      "ValueBefore": "Test1",
      "Timestamp": "2021-10-20T12:56:27.2450000+02:00",
      "Username": "Struct",
      "TransactionType": "Product update",
      "TransactionUid": "a47053eb-f06a-4028-9669-d961a914634b",
      "NewValue": null
    },
    "ItemRevisionChange": [
      {
        "RevisionNo": 2,
        "RevisionValue": "Test2",
        "ValueBefore": "Test1",
        "Timestamp": "2021-10-20T12:56:27.2450000+02:00",
        "Username": "Struct",
        "TransactionType": "Product update",
        "TransactionUid": "6143737d-c00e-4b64-994a-f8fb181e6de7",
        "NewValue": null
      },
      {
        "RevisionNo": 1,
        "RevisionValue": "Test1",
        "ValueBefore": null,
        "Timestamp": "2021-10-19T10:27:23.0750000+02:00",
        "Username": "Struct",
        "TransactionType": "Product creation",
        "TransactionUid": "064e64bc-9e6a-487f-9559-a768fcad73b9",
        "NewValue": null
      }
    ]
  }
]

Get entities changed in a specific transaction

get
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired

Unique id of transaction to get changes for

Query parameters
entityTypesstringOptional

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

Responses
200

OK

application/json

Represents information on an entity that is changed in a specific transaction

EntityTypestring · nullableOptional

Type of entity

EntityIdstring · nullableOptional

The unique id of the entity

RevisionNointeger · int32Optional

The revision number assigned to the entity in this transaction

TransactionUidstring · uuidOptional

Unique id of the transaction

get/v1/transactions/{uid}/changedentities
GET /v1/transactions/{uid}/changedentities HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "EntityType": "Product",
    "EntityId": "3021",
    "RevisionNo": 2,
    "TransactionUid": "8caa7d75-f6f7-4bc1-be4a-fe7279ed585e"
  },
  {
    "EntityType": "Product",
    "EntityId": "265",
    "RevisionNo": 7,
    "TransactionUid": "8caa7d75-f6f7-4bc1-be4a-fe7279ed585e"
  },
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "TransactionUid": "8caa7d75-f6f7-4bc1-be4a-fe7279ed585e"
  }
]

Get entities changed in a batch of transactions

post

A maximum of 5000 transactions can be fetched at a time

Authorizations
AuthorizationstringRequired
Query parameters
entityTypesstringOptional

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

Bodystring · uuid[]
string · uuid[]Optional
Responses
200

OK

application/json

Represents information on an entity that is changed in a specific transaction

EntityTypestring · nullableOptional

Type of entity

EntityIdstring · nullableOptional

The unique id of the entity

RevisionNointeger · int32Optional

The revision number assigned to the entity in this transaction

TransactionUidstring · uuidOptional

Unique id of the transaction

post/v1/transactions/batch/changedentities
POST /v1/transactions/batch/changedentities HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 118

[
  "65a1215c-8b89-4e4b-9211-f6261fe2bec6",
  "035765e0-aa78-413b-bad7-97387e63afff",
  "a9f2390e-9060-46e3-84d3-73c72038cae9"
]
200

OK

[
  {
    "EntityType": "Product",
    "EntityId": "3021",
    "RevisionNo": 2,
    "TransactionUid": "04b1f170-3ad7-4297-9798-b002780d268b"
  },
  {
    "EntityType": "Product",
    "EntityId": "265",
    "RevisionNo": 7,
    "TransactionUid": "b2621bb6-3d0a-454f-b52e-c8741278f9c0"
  },
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "TransactionUid": "b2621bb6-3d0a-454f-b52e-c8741278f9c0"
  }
]

Get an entity's changes for in a specific revision

get
Authorizations
AuthorizationstringRequired
Path parameters
entityTypestringRequired

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

entityIdstringRequired

Id of entity

revisionNointeger · int32Required

Revision to get changes for

Responses
200

OK

application/json

Represents a change made to an entity in a specific revision

EntityTypestring · nullableOptional

Type of entity

EntityIdstring · nullableOptional

The unique id of the entity

RevisionNointeger · int32Optional

The revision number assigned to the entity in this transaction

DataTypestring · nullableOptional

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

get/v1/transactions/changes/{entityType}/{entityId}/{revisionNo}
GET /v1/transactions/changes/{entityType}/{entityId}/{revisionNo} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "DataType": "system.attribute.4c394e86-045a-4b1c-80f8-d7f55b9e78f3"
  },
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "DataType": "system.attribute.87bef6b5-a6f9-4ce2-857c-3f1455cf12b9"
  },
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "DataType": "system.attribute.8b169763-b113-48dd-a89f-e4db040f139c"
  }
]

Get revision changes for a batch of entities

post
Authorizations
AuthorizationstringRequired
Bodyobject · Struct.App.Api.Models.Transaction.EntityRevisionChangeRequestModel[]

Model for requesting revision changes

EntityTypestring · nullableOptional

Type of entity

EntityIdstring · nullableOptional

Unique id of entity

RevisionNointeger · int32Optional

Revision number

Responses
200

OK

application/json

Represents a change made to an entity in a specific revision

EntityTypestring · nullableOptional

Type of entity

EntityIdstring · nullableOptional

The unique id of the entity

RevisionNointeger · int32Optional

The revision number assigned to the entity in this transaction

DataTypestring · nullableOptional

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

post/v1/transactions/changes/batch
POST /v1/transactions/changes/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

[
  {
    "EntityType": "Product",
    "EntityId": "3022",
    "RevisionNo": 2
  },
  {
    "EntityType": "Product",
    "EntityId": "3022",
    "RevisionNo": 3
  },
  {
    "EntityType": "Variant",
    "EntityId": "105633",
    "RevisionNo": 1
  }
]
200

OK

[
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "DataType": "system.attribute.b99ba0f7-bc9f-4b9c-9719-0f5ce5d15e10"
  },
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "DataType": "system.attribute.e4cc4e79-2d46-4b6e-bb2a-95bb1cb0a07e"
  },
  {
    "EntityType": "Product",
    "EntityId": "27601",
    "RevisionNo": 1,
    "DataType": "system.attribute.47af17b2-37db-433b-8a93-8ee3f2f1d9ac"
  }
]
PreviousSaved Search
NextUser Group

Last updated