> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/omnitron-openapis/sales-channel-cancellation-reasons.md).

# Sales Channel Cancellation Reasons

## Retrieve a cancellation reason

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

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}},"responses":{"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/cancellation_reasons/{id}/":{"get":{"summary":"Retrieve a cancellation reason","description":"Fetches the details of a specific cancellation reason for the specified sales channel.","tags":["SalesChannelCancellationReasons"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Cancellation reason retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationReason"}}}},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Partially update a cancellation reason

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

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"CancellationReasonUpdate":{"type":"object","description":"Schema for updating existing cancellation reason.","properties":{"cancellation_type":{"type":"string","enum":["cancel","refund"],"description":"Type of cancellation. Optional, defaults to `cancel`."},"extra_information_needed":{"type":"boolean","description":"Whether extra info is required."},"order":{"type":"integer","description":"Sorting order for UI display."},"subject":{"type":"string","description":"Short label of the cancellation reason."},"is_active":{"type":"boolean","description":"Whether this reason is active."},"send_to_remote":{"type":"boolean","description":"Whether this reason syncs to external systems."}}},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/cancellation_reasons/{id}/":{"put":{"summary":"Partially update a cancellation reason","description":"Partially updates the details of a specific cancellation reason for the specified sales channel.","tags":["SalesChannelCancellationReasons"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationReasonUpdate"}}}},"responses":{"200":{"description":"Cancellation reason partially updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationReason"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Delete a cancellation reason

> Deletes a specific cancellation reason for the specified sales channel by setting is\_active to False.

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"responses":{"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/cancellation_reasons/{id}/":{"delete":{"summary":"Delete a cancellation reason","description":"Deletes a specific cancellation reason for the specified sales channel by setting is_active to False.","tags":["SalesChannelCancellationReasons"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"204":{"description":"Cancellation reason deleted successfully."},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Update a cancellation reason

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

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"CancellationReasonUpdate":{"type":"object","description":"Schema for updating existing cancellation reason.","properties":{"cancellation_type":{"type":"string","enum":["cancel","refund"],"description":"Type of cancellation. Optional, defaults to `cancel`."},"extra_information_needed":{"type":"boolean","description":"Whether extra info is required."},"order":{"type":"integer","description":"Sorting order for UI display."},"subject":{"type":"string","description":"Short label of the cancellation reason."},"is_active":{"type":"boolean","description":"Whether this reason is active."},"send_to_remote":{"type":"boolean","description":"Whether this reason syncs to external systems."}}},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/cancellation_reasons/{id}/":{"patch":{"summary":"Update a cancellation reason","description":"Updates the details of a specific cancellation reason for the specified sales channel.","tags":["SalesChannelCancellationReasons"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationReasonUpdate"}}}},"responses":{"200":{"description":"Cancellation reason updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationReason"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## List all cancellation reasons

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

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"cancellation_type":{"name":"cancellation_type","in":"query","description":"Filter by cancellation type","required":false,"schema":{"type":"string","enum":["cancel","refund"]}},"is_active":{"name":"is_active","in":"query","description":"Filter by active status (True or False)","required":false,"schema":{"type":"boolean"}},"pk__in":{"name":"pk__in","in":"query","description":"Filter by multiple primary key values (comma-separated list of integers)","required":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":false}},"schemas":{"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}},"responses":{"403":{"description":"Forbidden"},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/cancellation_reasons/":{"get":{"summary":"List all cancellation reasons","description":"Fetches a list of all cancellation reasons for the specified sales channel.","tags":["SalesChannelCancellationReasons"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/cancellation_type"},{"$ref":"#/components/parameters/is_active"},{"$ref":"#/components/parameters/pk__in"}],"responses":{"200":{"description":"List of cancellation reasons retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CancellationReason"}}}}},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Create a cancellation reason

> Creates a new cancellation reason for the specified sales channel.

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}}},"schemas":{"CancellationReasonCreate":{"type":"object","description":"Schema for creating a new cancellation reason.","properties":{"cancellation_type":{"type":"string","enum":["cancel","refund"],"description":"Type of cancellation. Optional, defaults to `cancel`."},"extra_information_needed":{"type":"boolean","description":"Whether extra info is required."},"order":{"type":"integer","description":"Sorting order for UI display."},"subject":{"type":"string","description":"Short label of the cancellation reason."},"is_active":{"type":"boolean","description":"Whether this reason is active."},"send_to_remote":{"type":"boolean","description":"Whether this reason syncs to external systems."}},"required":["subject"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/cancellation_reasons/":{"post":{"summary":"Create a cancellation reason","description":"Creates a new cancellation reason for the specified sales channel.","tags":["SalesChannelCancellationReasons"],"parameters":[{"$ref":"#/components/parameters/channel_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationReasonCreate"}}}},"responses":{"201":{"description":"Cancellation reason created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationReason"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidocs.akinon.com/omnitron-openapis/sales-channel-cancellation-reasons.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.