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

Sales Channel Cancellation Request Image

Get cancellation request images that need to be inserted or updated

get

Returns a list of cancellation request images inserted or updated in the sales channel

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
attributesobjectOptional

Filter by image attributes

cancellation_requestintegerOptional

Filter by cancellation request ID

uploaded_byintegerOptional

Filter by user who uploaded the image

Responses
200

List of cancellation request images to be inserted or updated

application/json
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

idintegerOptional

Unique identifier for the cancellation request image

cancellation_requestintegerOptional

ID of the associated cancellation request

imagestring · uriOptional

URL of the uploaded image

descriptionstringOptional

Description of the image

attributesobjectOptional

Additional attributes for the image

uploaded_byintegerOptional

ID of the user who uploaded the image

get/api/channel/{channel_id}/cancellation_request_images/inserts_or_updates/

Retrieve a cancellation request image

get

Returns details of a specific cancellation request image. Only accessible to authenticated users with JWT token.

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200

Cancellation request image details

application/json
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

idintegerOptional

Unique identifier for the cancellation request image

cancellation_requestintegerOptional

ID of the associated cancellation request

imagestring · uriOptional

URL of the uploaded image

descriptionstringOptional

Description of the image

attributesobjectOptional

Additional attributes for the image

uploaded_byintegerOptional

ID of the user who uploaded the image

get/api/channel/{channel_id}/cancellation_request_images/{id}/

Get cancellation request images that need to be updated

get

Returns a list of cancellation request images that updated in the sales channel

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
attributesobjectOptional

Filter by image attributes

cancellation_requestintegerOptional

Filter by cancellation request ID

uploaded_byintegerOptional

Filter by user who uploaded the image

Responses
200

List of cancellation request images to be updated

application/json
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

idintegerOptional

Unique identifier for the cancellation request image

cancellation_requestintegerOptional

ID of the associated cancellation request

imagestring · uriOptional

URL of the uploaded image

descriptionstringOptional

Description of the image

attributesobjectOptional

Additional attributes for the image

uploaded_byintegerOptional

ID of the user who uploaded the image

get/api/channel/{channel_id}/cancellation_request_images/updates/

List all cancellation request images

get

Returns a list of all cancellation request images with optional filtering

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
attributesobjectOptional

Filter by image attributes

cancellation_requestintegerOptional

Filter by cancellation request ID

uploaded_byintegerOptional

Filter by user who uploaded the image

Responses
200

List of cancellation request images

application/json
countintegerOptional

Total number of items

nextstring · uri · nullableOptional

URL of the next page

previousstring · uri · nullableOptional

URL of the previous page

get/api/channel/{channel_id}/cancellation_request_images/

Get cancellation request images that need to be inserted

get

Returns a list of cancellation request images inserted in the sales channel

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
attributesobjectOptional

Filter by image attributes

cancellation_requestintegerOptional

Filter by cancellation request ID

uploaded_byintegerOptional

Filter by user who uploaded the image

Responses
200

List of cancellation request images to be inserted

application/json
created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

idintegerOptional

Unique identifier for the cancellation request image

cancellation_requestintegerOptional

ID of the associated cancellation request

imagestring · uriOptional

URL of the uploaded image

descriptionstringOptional

Description of the image

attributesobjectOptional

Additional attributes for the image

uploaded_byintegerOptional

ID of the user who uploaded the image

get/api/channel/{channel_id}/cancellation_request_images/inserts/

Last updated

Was this helpful?