SalesChannelCancellationRequestImage

PreviousSalesChannelMarketPlaceAttributeSetConfig NextSalesChannelCities

Was this helpful?

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

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

400

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

application/json

401

Unauthorized Access

application/json

500

Server Error

get

GET /api/channel/{channel_id}/cancellation_request_images/inserts_or_updates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-05-22T10:05:30.688Z",
    "modified_date": "2025-05-22T10:05:30.688Z"
  }
]

Retrieve a cancellation request image

get

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

Authorizations

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

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/channel/{channel_id}/cancellation_request_images/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "cancellation_request": 1,
  "image": "https://example.com",
  "description": "text",
  "attributes": {},
  "uploaded_by": 1,
  "created_date": "2025-05-22T10:05:30.688Z",
  "modified_date": "2025-05-22T10:05:30.688Z"
}

Get cancellation request images that need to be updated

get

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

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 to be updated

application/json

400

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

application/json

401

Unauthorized Access

application/json

500

Server Error

get

GET /api/channel/{channel_id}/cancellation_request_images/updates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-05-22T10:05:30.688Z",
    "modified_date": "2025-05-22T10:05:30.688Z"
  }
]

List all cancellation request images

get

Returns a list of all cancellation request images with optional filtering

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

400

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

application/json

401

Unauthorized Access

application/json

500

Server Error

get

GET /api/channel/{channel_id}/cancellation_request_images/ HTTP/1.1
Host: 
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2025-05-22T10:05:30.688Z",
      "modified_date": "2025-05-22T10:05:30.688Z"
    }
  ]
}

Get cancellation request images that need to be inserted

get

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

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 to be inserted

application/json

400

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

application/json

401

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

application/json

get

GET /api/channel/{channel_id}/cancellation_request_images/inserts/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-05-22T10:05:30.688Z",
    "modified_date": "2025-05-22T10:05:30.688Z"
  }
]