Sales Channel Cancellation Reasons

Retrieve a cancellation reason

get

Fetches the details of a specific cancellation reason for the specified sales channel.

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 reason retrieved successfully.

application/json

Represents a reason for order cancellation

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.

pkintegerRead-onlyOptional

Primary key of the cancellation reason

cancellation_typestring · enumRequired

Type of cancellation

Example: cancelPossible values:

extra_information_neededbooleanOptional

Whether extra information is needed for this cancellation reason

Default: false

orderintegerOptional

Order of display for the cancellation reason

Default: 100

subjectstring · max: 100Required

Subject/name of the cancellation reason

is_activebooleanOptional

Whether the cancellation reason is active

Default: true

send_to_remotebooleanOptional

Whether to send this reason to remote systems

send_to_omsbooleanOptional

Whether to send this reason to OMS

translationsobjectRead-onlyOptional

Translations for the cancellation reason

uuidstringRead-onlyOptional

Unique identifier for the cancellation reason

403

Forbidden

404

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

application/json

500

Server Error

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

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

{
  "pk": 1,
  "cancellation_type": "cancel",
  "extra_information_needed": false,
  "order": 100,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true,
  "send_to_oms": true,
  "translations": {},
  "uuid": "text",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}

Partially update a cancellation reason

put

Partially updates the details of a specific cancellation reason for the specified sales channel.

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

Schema for updating existing cancellation reason.

cancellation_typestring · enumOptional

Type of cancellation. Optional, defaults to cancel.

Possible values:

extra_information_neededbooleanOptional

Whether extra info is required.

orderintegerOptional

Sorting order for UI display.

subjectstringOptional

Short label of the cancellation reason.

is_activebooleanOptional

Whether this reason is active.

send_to_remotebooleanOptional

Whether this reason syncs to external systems.

Responses

200

Cancellation reason partially updated successfully.

application/json

Represents a reason for order cancellation

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.

pkintegerRead-onlyOptional

Primary key of the cancellation reason

cancellation_typestring · enumRequired

Type of cancellation

Example: cancelPossible values:

extra_information_neededbooleanOptional

Whether extra information is needed for this cancellation reason

Default: false

orderintegerOptional

Order of display for the cancellation reason

Default: 100

subjectstring · max: 100Required

Subject/name of the cancellation reason

is_activebooleanOptional

Whether the cancellation reason is active

Default: true

send_to_remotebooleanOptional

Whether to send this reason to remote systems

send_to_omsbooleanOptional

Whether to send this reason to OMS

translationsobjectRead-onlyOptional

Translations for the cancellation reason

uuidstringRead-onlyOptional

Unique identifier for the cancellation reason

400

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

application/json

403

Forbidden

404

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

application/json

500

Server Error

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

PUT /api/v1/channel/{channel_id}/cancellation_reasons/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "cancellation_type": "cancel",
  "extra_information_needed": true,
  "order": 1,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true
}

{
  "pk": 1,
  "cancellation_type": "cancel",
  "extra_information_needed": false,
  "order": 100,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true,
  "send_to_oms": true,
  "translations": {},
  "uuid": "text",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}

Delete a cancellation reason

delete

Deletes a specific cancellation reason for the specified sales channel by setting is_active to False.

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Cancellation reason deleted successfully.

No content

403

Forbidden

404

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

application/json

500

Server Error

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

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

No content

Update a cancellation reason

patch

Updates the details of a specific cancellation reason for the specified sales channel.

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

Schema for updating existing cancellation reason.

cancellation_typestring · enumOptional

Type of cancellation. Optional, defaults to cancel.

Possible values:

extra_information_neededbooleanOptional

Whether extra info is required.

orderintegerOptional

Sorting order for UI display.

subjectstringOptional

Short label of the cancellation reason.

is_activebooleanOptional

Whether this reason is active.

send_to_remotebooleanOptional

Whether this reason syncs to external systems.

Responses

200

Cancellation reason updated successfully.

application/json

Represents a reason for order cancellation

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.

pkintegerRead-onlyOptional

Primary key of the cancellation reason

cancellation_typestring · enumRequired

Type of cancellation

Example: cancelPossible values:

extra_information_neededbooleanOptional

Whether extra information is needed for this cancellation reason

Default: false

orderintegerOptional

Order of display for the cancellation reason

Default: 100

subjectstring · max: 100Required

Subject/name of the cancellation reason

is_activebooleanOptional

Whether the cancellation reason is active

Default: true

send_to_remotebooleanOptional

Whether to send this reason to remote systems

send_to_omsbooleanOptional

Whether to send this reason to OMS

translationsobjectRead-onlyOptional

Translations for the cancellation reason

uuidstringRead-onlyOptional

Unique identifier for the cancellation reason

400

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

application/json

403

Forbidden

404

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

application/json

500

Server Error

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

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

{
  "cancellation_type": "cancel",
  "extra_information_needed": true,
  "order": 1,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true
}

{
  "pk": 1,
  "cancellation_type": "cancel",
  "extra_information_needed": false,
  "order": 100,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true,
  "send_to_oms": true,
  "translations": {},
  "uuid": "text",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}

List all cancellation reasons

get

Fetches a list of all cancellation reasons for the specified sales channel.

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

cancellation_typestring · enumOptional

Filter by cancellation type

Possible values:

is_activebooleanOptional

Filter by active status (True or False)

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

Responses

200

List of cancellation reasons retrieved successfully.

application/json

Represents a reason for order cancellation

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.

pkintegerRead-onlyOptional

Primary key of the cancellation reason

cancellation_typestring · enumRequired

Type of cancellation

Example: cancelPossible values:

extra_information_neededbooleanOptional

Whether extra information is needed for this cancellation reason

Default: false

orderintegerOptional

Order of display for the cancellation reason

Default: 100

subjectstring · max: 100Required

Subject/name of the cancellation reason

is_activebooleanOptional

Whether the cancellation reason is active

Default: true

send_to_remotebooleanOptional

Whether to send this reason to remote systems

send_to_omsbooleanOptional

Whether to send this reason to OMS

translationsobjectRead-onlyOptional

Translations for the cancellation reason

uuidstringRead-onlyOptional

Unique identifier for the cancellation reason

403

Forbidden

500

Server Error

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

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

[
  {
    "created_date": "2026-01-01T00:00:00.000Z",
    "modified_date": "2026-01-01T00:00:00.000Z"
  }
]

Create a cancellation reason

post

Creates a new cancellation reason for the specified sales channel.

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

Schema for creating a new cancellation reason.

cancellation_typestring · enumOptional

Type of cancellation. Optional, defaults to cancel.

Possible values:

extra_information_neededbooleanOptional

Whether extra info is required.

orderintegerOptional

Sorting order for UI display.

subjectstringRequired

Short label of the cancellation reason.

is_activebooleanOptional

Whether this reason is active.

send_to_remotebooleanOptional

Whether this reason syncs to external systems.

Responses

201

Cancellation reason created successfully.

application/json

Represents a reason for order cancellation

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.

pkintegerRead-onlyOptional

Primary key of the cancellation reason

cancellation_typestring · enumRequired

Type of cancellation

Example: cancelPossible values:

extra_information_neededbooleanOptional

Whether extra information is needed for this cancellation reason

Default: false

orderintegerOptional

Order of display for the cancellation reason

Default: 100

subjectstring · max: 100Required

Subject/name of the cancellation reason

is_activebooleanOptional

Whether the cancellation reason is active

Default: true

send_to_remotebooleanOptional

Whether to send this reason to remote systems

send_to_omsbooleanOptional

Whether to send this reason to OMS

translationsobjectRead-onlyOptional

Translations for the cancellation reason

uuidstringRead-onlyOptional

Unique identifier for the cancellation reason

400

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

application/json

403

Forbidden

500

Server Error

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

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

{
  "cancellation_type": "cancel",
  "extra_information_needed": true,
  "order": 1,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true
}

{
  "pk": 1,
  "cancellation_type": "cancel",
  "extra_information_needed": false,
  "order": 100,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true,
  "send_to_oms": true,
  "translations": {},
  "uuid": "text",
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}