IntegrationActions

Retrieve integration action

get

Get details of a specific integration action

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Integration action details

application/json

object_idintegerOptional

ID of the related object (used with GenericForeignKey)

remote_idstring · max: 255 · nullableOptional

version_datestring · date-timeOptional

The version date of the action

stateobjectOptional

JSON representation of the state

local_batch_idstring · max: 255 · nullableOptional

statusstring · enumOptional

Status of the integration action

Possible values:

content_objectobject · nullableOptional

Generic foreign key, handled dynamically

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/integration_actions/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/integration_actions/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "content_type": {
    "id": 1,
    "app_label": "text",
    "model": "text"
  },
  "object_id": 1,
  "remote_id": "text",
  "version_date": "2026-03-06T20:00:55.222Z",
  "state": {},
  "local_batch_id": "text",
  "status": "processing",
  "content_object": {}
}

Delete integration action

delete

Delete a specific integration action

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Integration action deleted successfully

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete

/api/v1/channel/{channel_id}/integration_actions/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/channel/{channel_id}/integration_actions/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Update integration action (PATCH)

patch

Partially update an existing integration action

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

anyOptional

or

anyOptional

Responses

200

Integration action updated successfully

application/json

object_idintegerOptional

ID of the related object (used with GenericForeignKey)

remote_idstring · max: 255 · nullableOptional

version_datestring · date-timeOptional

The version date of the action

stateobjectOptional

JSON representation of the state

local_batch_idstring · max: 255 · nullableOptional

statusstring · enumOptional

Status of the integration action

Possible values:

content_objectobject · nullableOptional

Generic foreign key, handled dynamically

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

/api/v1/channel/{channel_id}/integration_actions/{id}/

HTTPcURLJavaScriptPython

PATCH /api/v1/channel/{channel_id}/integration_actions/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "channel_id": 1,
  "remote_id": "text",
  "version_date": "2026-03-06T20:00:55.222Z",
  "state": {},
  "object_id": 1,
  "content_type_id": 1,
  "content_type_model": "text"
}

{
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "content_type": {
    "id": 1,
    "app_label": "text",
    "model": "text"
  },
  "object_id": 1,
  "remote_id": "text",
  "version_date": "2026-03-06T20:00:55.222Z",
  "state": {},
  "local_batch_id": "text",
  "status": "processing",
  "content_object": {}
}

List deleted integration actions

get

Retrieve a list of deleted integration actions for a specific model

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

modelstringRequired

Model name to filter deleted actions

pageintegerOptional

Page number for pagination

page_sizeintegerOptional

Number of items per page

Responses

200

List of deleted integration actions

application/json

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for next page

previousstring · nullableOptional

URL for previous page

403

Forbidden

404

Not Found

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/integration_actions/deleted/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/integration_actions/deleted/?model=text HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "channel": {
        "id": 1,
        "name": "Commerce Channel",
        "catalog": 1,
        "channel_type": "web",
        "conf": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "category_tree": "text",
        "is_active": true,
        "schema": {},
        "created_date": "2024-11-20T11:22:23.702774Z",
        "modified_date": "2024-11-20T11:22:23.702774Z"
      },
      "content_type": {
        "id": 1,
        "app_label": "text",
        "model": "text"
      },
      "object_id": 1,
      "remote_id": "text",
      "version_date": "2026-03-06T20:00:55.222Z",
      "state": {},
      "local_batch_id": "text",
      "status": "processing",
      "content_object": {}
    }
  ]
}

List integration actions

get

Retrieve a list of integration actions for a specific channel

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageintegerOptional

Page number for pagination

page_sizeintegerOptional

Number of items per page

orderingstringOptional

Field to order results by

Responses

200

List of integration actions

application/json

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for next page

previousstring · nullableOptional

URL for previous page

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/integration_actions/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/integration_actions/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "channel": {
        "id": 1,
        "name": "Commerce Channel",
        "catalog": 1,
        "channel_type": "web",
        "conf": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "category_tree": "text",
        "is_active": true,
        "schema": {},
        "created_date": "2024-11-20T11:22:23.702774Z",
        "modified_date": "2024-11-20T11:22:23.702774Z"
      },
      "content_type": {
        "id": 1,
        "app_label": "text",
        "model": "text"
      },
      "object_id": 1,
      "remote_id": "text",
      "version_date": "2026-03-06T20:00:55.222Z",
      "state": {},
      "local_batch_id": "text",
      "status": "processing",
      "content_object": {}
    }
  ]
}

Create integration action

post

Create a new integration action for a specific channel

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

application/json

anyOptional

or

anyOptional

Responses

201

Integration action created successfully

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/channel/{channel_id}/integration_actions/

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/integration_actions/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "channel_id": 1,
  "remote_id": "text",
  "version_date": "2026-03-06T20:00:55.222Z",
  "state": {},
  "object_id": 1,
  "content_type_id": 1,
  "content_type_model": "text"
}

{
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "content_type": {
    "id": 1,
    "app_label": "text",
    "model": "text"
  },
  "object_id": 1,
  "remote_id": "text",
  "version_date": "2026-03-06T20:00:55.222Z",
  "state": {},
  "local_batch_id": "text",
  "status": "processing",
  "content_object": {}
}

List detailed integration actions

get

Retrieve a detailed list of integration actions for a specific channel

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageintegerOptional

Page number for pagination

page_sizeintegerOptional

Number of items per page

orderingstringOptional

Field to order results by

Responses

200

Detailed list of integration actions

application/json

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for next page

previousstring · nullableOptional

URL for previous page

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/integration_actions/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/integration_actions/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "channel": {
        "id": 1,
        "name": "Commerce Channel",
        "catalog": 1,
        "channel_type": "web",
        "conf": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "category_tree": "text",
        "is_active": true,
        "schema": {},
        "created_date": "2024-11-20T11:22:23.702774Z",
        "modified_date": "2024-11-20T11:22:23.702774Z"
      },
      "content_type": {
        "id": 1,
        "app_label": "text",
        "model": "text"
      },
      "object_id": 1,
      "remote_id": "text",
      "version_date": "2026-03-06T20:00:55.222Z",
      "state": {},
      "local_batch_id": "text",
      "status": "processing",
      "content_object": {}
    }
  ]
}

Retrieve detailed integration action

get

Get detailed information of a specific integration action

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Detailed integration action information

application/json

object_idintegerOptional

ID of the related object (used with GenericForeignKey)

remote_idstring · max: 255 · nullableOptional

version_datestring · date-timeOptional

The version date of the action

stateobjectOptional

JSON representation of the state

local_batch_idstring · max: 255 · nullableOptional

statusstring · enumOptional

Status of the integration action

Possible values:

content_objectobject · nullableOptional

Generic foreign key, handled dynamically

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/integration_actions/{id}/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/integration_actions/{id}/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "content_type": {
    "id": 1,
    "app_label": "text",
    "model": "text"
  },
  "object_id": 1,
  "remote_id": "text",
  "version_date": "2026-03-06T20:00:55.222Z",
  "state": {},
  "local_batch_id": "text",
  "status": "processing",
  "content_object": {}
}