SalesChannelFailedIntegrations

Retrieve Sales Failed Integration by ID

get

Retrieve a specific Sales Channel Failed Integration 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
chevron-right
200

Sales Channel Failed Integration retrieved successfully

application/json
get
/api/v1/channel/{channel_id}/failed_integrations/{id}/

Update Sales Channel Failed Integration

put

Update a specific Sales Channel Failed Integration 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
pkintegerRead-onlyOptional

Unique identifier for the failed integration

channelintegerRequired

Foreign key to Channel model

version_datestring · date-timeRequired

Version date of the integration attempt (indexed)

reason_typestring · enum · max: 15Required

Type of reason for failure

Possible values:
is_activebooleanOptional

Whether the failed integration is active

Default: true
content_typeintegerRequired

Foreign key to ContentType model for polymorphic relationship

object_idintegerRequired

ID of the related object

expiration_datestring · date-time | nullableOptional

Date when the failed integration record expires

retry_countintegerOptional

Number of retry attempts made

Default: 1
max_retry_countintegerOptional

Maximum number of retry attempts allowed

Default: 1
retry_intervalintegerOptional

Interval between retry attempts in seconds

Default: 0
integration_actioninteger | nullableOptional

Foreign key to IntegrationAction model

log_idinteger | nullableOptional

ID reference to related log entry

Responses
chevron-right
200

Sales Channel Failed Integration updated

No content

put
/api/v1/channel/{channel_id}/failed_integrations/{id}/

No content

Delete Sales Channel Failed Integration

delete

Delete Sales Channel Failed Integration for a specific channel.

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
delete
/api/v1/channel/{channel_id}/failed_integrations/{id}/

No content

Partial Update Sales Channel Failed Integration

patch

Partial update a specific Sales Channel Failed Integration 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
pkintegerRead-onlyOptional

Unique identifier for the failed integration

channelintegerRequired

Foreign key to Channel model

version_datestring · date-timeRequired

Version date of the integration attempt (indexed)

reason_typestring · enum · max: 15Required

Type of reason for failure

Possible values:
is_activebooleanOptional

Whether the failed integration is active

Default: true
content_typeintegerRequired

Foreign key to ContentType model for polymorphic relationship

object_idintegerRequired

ID of the related object

expiration_datestring · date-time | nullableOptional

Date when the failed integration record expires

retry_countintegerOptional

Number of retry attempts made

Default: 1
max_retry_countintegerOptional

Maximum number of retry attempts allowed

Default: 1
retry_intervalintegerOptional

Interval between retry attempts in seconds

Default: 0
integration_actioninteger | nullableOptional

Foreign key to IntegrationAction model

log_idinteger | nullableOptional

ID reference to related log entry

Responses
chevron-right
200

Sales Channel Failed Integration updated

No content

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

No content

List Sales Channel Failed Integrations

get

List Sales Channel Failed Integrations

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
channelintegerOptional

ID of the channel the customer belongs to

Example: 5
Responses
chevron-right
200

OK

application/json
get
/api/v1/channel/{channel_id}/failed_integrations/

Create Sales Channel Failed Integration

post

Create Sales Channel Failed Integration for a specific channel.

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Body
pkintegerRead-onlyOptional

Unique identifier for the failed integration

channelintegerRequired

Foreign key to Channel model

version_datestring · date-timeRequired

Version date of the integration attempt (indexed)

reason_typestring · enum · max: 15Required

Type of reason for failure

Possible values:
is_activebooleanOptional

Whether the failed integration is active

Default: true
content_typeintegerRequired

Foreign key to ContentType model for polymorphic relationship

object_idintegerRequired

ID of the related object

expiration_datestring · date-time | nullableOptional

Date when the failed integration record expires

retry_countintegerOptional

Number of retry attempts made

Default: 1
max_retry_countintegerOptional

Maximum number of retry attempts allowed

Default: 1
retry_intervalintegerOptional

Interval between retry attempts in seconds

Default: 0
integration_actioninteger | nullableOptional

Foreign key to IntegrationAction model

log_idinteger | nullableOptional

ID reference to related log entry

Responses
post
/api/v1/channel/{channel_id}/failed_integrations/

Last updated

Was this helpful?