SalesChannelErrorReports

PreviousSalesChannelMarketPlaceAttributeSet NextSalesChannelCategoryNodes

Was this helpful?

Delete Sales Channel Error Report

delete

Delete a specific Sales Channel Error Report by ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Error Report deleted

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

delete

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

No content

Retrieve Sales Channel Error Report

get

Retrieve a specific Sales Channel Error Report by ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Error Report retrieved successfully

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get

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

{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-05-22T09:57:35.390Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-05-22T09:57:35.390Z",
  "updated_date": "2025-05-22T09:57:35.390Z"
}

List Sales Channel Error Reports

get

List Sales Channel Error Reports

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

catalogstringOptional

Filter by catalog name

target_content_typestringOptional

Filter by target content type model name

target_content_type_idintegerOptional

Filter by target content type ID

target_object_idintegerOptional

Filter by target object ID

action_content_typestringOptional

Filter by action content type model name

action_content_type_idintegerOptional

Filter by action content type ID

action_object_id__ininteger[]Optional

Filter by multiple action object IDs

is_okbooleanOptional

Filter by status flag

Responses

200

List of Error Reports

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get

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

[
  {
    "id": 1,
    "action_content_type": 1,
    "action_object_id": 1,
    "action": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "target_content_type": 1,
    "target_object_id": "text",
    "target": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "obj_modified_date": "2025-05-22T09:57:35.390Z",
    "error_code": "text",
    "error_desc": "text",
    "is_ok": false,
    "raw_request": "text",
    "raw_response": "text",
    "created_date": "2025-05-22T09:57:35.390Z",
    "updated_date": "2025-05-22T09:57:35.390Z"
  }
]

List Sales Channel Error Reports

get

List Sales Channel Error Reports

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

catalogstringOptional

Filter by catalog name

target_content_typestringOptional

Filter by target content type model name

target_content_type_idintegerOptional

Filter by target content type ID

target_object_idintegerOptional

Filter by target object ID

action_content_typestringOptional

Filter by action content type model name

action_content_type_idintegerOptional

Filter by action content type ID

action_object_id__ininteger[]Optional

Filter by multiple action object IDs

is_okbooleanOptional

Filter by status flag

Responses

200

List of Error Reports

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get

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

[
  {
    "id": 1,
    "action_content_type": 1,
    "action_object_id": 1,
    "action": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "target_content_type": 1,
    "target_object_id": "text",
    "target": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "obj_modified_date": "2025-05-22T09:57:35.390Z",
    "error_code": "text",
    "error_desc": "text",
    "is_ok": false,
    "raw_request": "text",
    "raw_response": "text",
    "created_date": "2025-05-22T09:57:35.390Z",
    "updated_date": "2025-05-22T09:57:35.390Z"
  }
]

List Sales Channel Product Error Reports

get

Get list of sales channel product error reports

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

Responses

200

List of Product Error Reports

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/error_reports/product/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "action_content_type": 1,
    "action_object_id": 1,
    "action": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "target_content_type": 1,
    "target_object_id": "text",
    "target": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "obj_modified_date": "2025-05-22T09:57:35.390Z",
    "error_code": "text",
    "error_desc": "text",
    "is_ok": false,
    "raw_request": "text",
    "raw_response": "text",
    "created_date": "2025-05-22T09:57:35.390Z",
    "updated_date": "2025-05-22T09:57:35.390Z"
  }
]

Retrieve Sales Channel Error Report

get

Retrieve a specific Sales Channel Error Report by ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Error Report retrieved successfully

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get

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

{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-05-22T09:57:35.390Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-05-22T09:57:35.390Z",
  "updated_date": "2025-05-22T09:57:35.390Z"
}

Create Sales Channel Distinct Error Report

post

Create Sales Channel Distinct Error Report for a specific channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

remote_codestring · max: 255Required

The remote code for the integration mapping

city_idinteger | nullableOptional

ID of the city

country_idinteger | nullableRequired

ID of the country

township_idinteger | nullableOptional

ID of the township

namestring | nullableOptional

Name of the integration mapping

integration_typestring · enumRequired

Type of integration mapping

Example: webPossible values:

err_codestring | nullableRequired

Error code if any

err_descstring | nullableRequired

Error description if any

Responses

201

Distinct Error Report Created

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

post

POST /api/v1/channel/{channel_id}/error_reports/distinct/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "remote_code": "text",
  "city_id": 1,
  "country_id": 1,
  "township_id": 1,
  "name": "text",
  "integration_type": "web",
  "err_code": "text",
  "err_desc": "text"
}

No content

Partial Update Sales Channel Error Report

patch

Partial update a specific Sales Channel Error Report by ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

idintegerRead-onlyOptional

Error report ID

action_content_typeintegerRequired

Content type ID for action

action_object_idintegerRequired

Object ID for action

target_content_typeinteger | nullableOptional

Content type ID for target

target_object_idstring | nullableOptional

Object ID for target

obj_modified_datestring · date-timeRequired

Object modification date

error_codestring · max: 128Required

Error code

error_descstringRequired

Error description

is_okbooleanOptional

Status flag

Default: false

raw_requeststring | nullableOptional

Raw request data

raw_responsestring | nullableOptional

Raw response data

created_datestring · date-timeRead-onlyOptional

Creation timestamp

updated_datestring · date-timeRead-onlyOptional

Last update timestamp

Responses

200

Error Report updated

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

patch

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

{
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-05-22T09:57:35.390Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text"
}

No content

Create Sales Channel Township Error Report

post

Create Sales Channel Township Error Report for a specific channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

remote_codestring · max: 255Required

The remote code for the integration mapping

city_idinteger | nullableOptional

ID of the city

country_idinteger | nullableRequired

ID of the country

township_idinteger | nullableOptional

ID of the township

namestring | nullableOptional

Name of the integration mapping

integration_typestring · enumRequired

Type of integration mapping

Example: webPossible values:

err_codestring | nullableRequired

Error code if any

err_descstring | nullableRequired

Error description if any

Responses

201

Township Error Report Created

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

post

POST /api/v1/channel/{channel_id}/error_reports/township/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "remote_code": "text",
  "city_id": 1,
  "country_id": 1,
  "township_id": 1,
  "name": "text",
  "integration_type": "web",
  "err_code": "text",
  "err_desc": "text"
}

No content

Create Sales Channel City Error Report

post

Create Sales Channel City Error Report for a specific channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

remote_codestring · max: 255Required

The remote code for the integration mapping

city_idinteger | nullableOptional

ID of the city

country_idinteger | nullableRequired

ID of the country

township_idinteger | nullableOptional

ID of the township

namestring | nullableOptional

Name of the integration mapping

integration_typestring · enumRequired

Type of integration mapping

Example: webPossible values:

err_codestring | nullableRequired

Error code if any

err_descstring | nullableRequired

Error description if any

Responses

201

City Error Report Created

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

post

POST /api/v1/channel/{channel_id}/error_reports/city/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "remote_code": "text",
  "city_id": 1,
  "country_id": 1,
  "township_id": 1,
  "name": "text",
  "integration_type": "web",
  "err_code": "text",
  "err_desc": "text"
}

No content

Create Sales Channel Error Report

post

Create Sales Channel Error Report for a specific channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

idintegerRead-onlyOptional

Error report ID

action_content_typeintegerRequired

Content type ID for action

action_object_idintegerRequired

Object ID for action

target_content_typeinteger | nullableOptional

Content type ID for target

target_object_idstring | nullableOptional

Object ID for target

obj_modified_datestring · date-timeRequired

Object modification date

error_codestring · max: 128Required

Error code

error_descstringRequired

Error description

is_okbooleanOptional

Status flag

Default: false

raw_requeststring | nullableOptional

Raw request data

raw_responsestring | nullableOptional

Raw response data

created_datestring · date-timeRead-onlyOptional

Creation timestamp

updated_datestring · date-timeRead-onlyOptional

Last update timestamp

Responses

201

Error Report Created

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

post

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

{
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-05-22T09:57:35.390Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text"
}

{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-05-22T09:57:35.390Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-05-22T09:57:35.390Z",
  "updated_date": "2025-05-22T09:57:35.390Z"
}

Partial Update Sales Channel Error Report Action Object ID

patch

Partial update a specific Sales Channel Error Report by ID with Action Object ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

action_object_idintegerOptional

Responses

200

Success

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

patch

PATCH /api/v1/channel/{channel_id}/error_reports/{id}/update_action_object_id/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "action_object_id": 1
}

{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-05-22T09:57:35.390Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-05-22T09:57:35.390Z",
  "updated_date": "2025-05-22T09:57:35.390Z"
}

Update Error Code of Sales Channel Error Report

patch

Update error code of sales channel error report

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

error_codestringOptional

Responses

200

Success

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

patch

PATCH /api/v1/channel/{channel_id}/error_reports/{id}/update_error_code/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "error_code": "text"
}

{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-05-22T09:57:35.390Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-05-22T09:57:35.390Z",
  "updated_date": "2025-05-22T09:57:35.390Z"
}