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

Sales Channel Error Reports

Create Sales Channel Distinct Error Report

post

Create Sales Channel Distinct Error Report for a specific channel.

Authorizations
AuthorizationstringRequired
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

No content

post/api/v1/channel/{channel_id}/error_reports/distinct/

No content

Retrieve Sales Channel Error Report

get

Retrieve a specific Sales Channel Error Report by ID

Authorizations
AuthorizationstringRequired
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
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 · max: 255 · 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

get/api/v1/channel/{channel_id}/error_reports/{id}/

Delete Sales Channel Error Report

delete

Delete a specific Sales Channel Error Report by ID

Authorizations
AuthorizationstringRequired
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

No content

delete/api/v1/channel/{channel_id}/error_reports/{id}/

No content

Partial Update Sales Channel Error Report

patch

Partial update a specific Sales Channel Error Report by ID

Authorizations
AuthorizationstringRequired
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 · max: 255 · 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

No content

patch/api/v1/channel/{channel_id}/error_reports/{id}/

No content

Retrieve Sales Channel Error Report

get

Retrieve a specific Sales Channel Error Report by ID

Authorizations
AuthorizationstringRequired
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
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 · max: 255 · 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

get/api/v1/channel/{channel_id}/error_reports/{id}/detailed/

Create Sales Channel Township Error Report

post

Create Sales Channel Township Error Report for a specific channel.

Authorizations
AuthorizationstringRequired
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

No content

post/api/v1/channel/{channel_id}/error_reports/township/

No content

Create Sales Channel City Error Report

post

Create Sales Channel City Error Report for a specific channel.

Authorizations
AuthorizationstringRequired
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

No content

post/api/v1/channel/{channel_id}/error_reports/city/

No content

List Sales Channel Error Reports

get

List Sales Channel Error Reports

Authorizations
AuthorizationstringRequired
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
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 · max: 255 · 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

get/api/v1/channel/{channel_id}/error_reports/

Create Sales Channel Error Report

post

Create Sales Channel Error Report for a specific channel.

Authorizations
AuthorizationstringRequired
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 · max: 255 · 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
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 · max: 255 · 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

post/api/v1/channel/{channel_id}/error_reports/

List Sales Channel Error Reports

get

List Sales Channel Error Reports

Authorizations
AuthorizationstringRequired
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
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 · max: 255 · 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

get/api/v1/channel/{channel_id}/error_reports/detailed/

List Sales Channel Product Error Reports

get

Get list of sales channel product error reports

Authorizations
AuthorizationstringRequired
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
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 · max: 255 · 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

get/api/v1/channel/{channel_id}/error_reports/product/

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
AuthorizationstringRequired
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
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 · max: 255 · 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

patch/api/v1/channel/{channel_id}/error_reports/{id}/update_action_object_id/

Update Error Code of Sales Channel Error Report

patch

Update error code of sales channel error report

Authorizations
AuthorizationstringRequired
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
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 · max: 255 · 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

patch/api/v1/channel/{channel_id}/error_reports/{id}/update_error_code/

Last updated

Was this helpful?