Cancellation Reasons

Retrieve cancellation reason

get

Retrieve a specific cancellation reason by ID.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Cancellation reason retrieved successfully

application/json

Represents a reason for order cancellation

401

Unauthorized Access

application/json

403

Forbidden

404

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

application/json

500

Server Error

get

/api/v1/cancellation_reasons/{id}

HTTPcURLJavaScriptPython

GET /api/v1/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-03-07T03:17:27.008Z",
  "modified_date": "2026-03-07T03:17:27.008Z"
}

Update cancellation reason

put

Update an existing cancellation reason.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

Input schema for creating or updating a 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

Responses

200

Cancellation reason updated successfully.

application/json

Represents a reason for order cancellation

400

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

application/json

401

Unauthorized Access

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/cancellation_reasons/{id}/

HTTPcURLJavaScriptPython

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

{
  "cancellation_type": "cancel",
  "extra_information_needed": false,
  "order": 100,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true,
  "send_to_oms": 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-03-07T03:17:27.008Z",
  "modified_date": "2026-03-07T03:17:27.008Z"
}

Delete cancellation reason

delete

Soft delete a cancellation reason by setting is_active to False.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No content

401

Unauthorized Access

application/json

403

Forbidden

404

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

application/json

500

Server Error

delete

/api/v1/cancellation_reasons/{id}/

HTTPcURLJavaScriptPython

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

No content

Partially update cancellation reason

patch

Partially update an existing cancellation reason.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

Input schema for creating or updating a 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

Responses

200

Cancellation reason partially updated successfully.

application/json

Represents a reason for order cancellation

400

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

application/json

401

Unauthorized Access

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/cancellation_reasons/{id}/

HTTPcURLJavaScriptPython

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

{
  "cancellation_type": "cancel",
  "extra_information_needed": false,
  "order": 100,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true,
  "send_to_oms": 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-03-07T03:17:27.008Z",
  "modified_date": "2026-03-07T03:17:27.008Z"
}

List cancellation reasons

get

Retrieve a paginated list of all cancellation reasons with filtering support.

Authorizations

Token

AuthorizationstringRequired

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

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000

cancellation_typestring · enumOptional

Filter by cancellation type

Possible values:

is_activebooleanOptional

Filter by active status (True or False)

send_to_omsbooleanOptional

Filter by send to OMS flag

send_to_remotebooleanOptional

Filter by send to remote flag

subjectstringOptional

Filter by subject

extra_information_neededbooleanOptional

Filter by extra information needed flag

orderintegerOptional

Filter by order display field

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

pk__ininteger[]Optional

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

Responses

200

A paginated list of cancellation reasons.

application/json

countintegerOptional

Total number of cancellation reasons available.

nextstring · nullableOptional

URL of the next results page.

previousstring · nullableOptional

URL of the previous results page.

401

Unauthorized Access

application/json

403

Forbidden

404

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

application/json

500

Server Error

get

/api/v1/cancellation_reasons/

HTTPcURLJavaScriptPython

GET /api/v1/cancellation_reasons/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-03-07T03:17:27.008Z",
      "modified_date": "2026-03-07T03:17:27.008Z"
    }
  ]
}

Create cancellation reason

post

Create a new cancellation reason.

Authorizations

Token

AuthorizationstringRequired

Body

application/json

Input schema for creating or updating a 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

Responses

201

Cancellation reason created successfully.

application/json

400

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

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

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

application/json

500

Server Error

post

/api/v1/cancellation_reasons/

HTTPcURLJavaScriptPython

POST /api/v1/cancellation_reasons/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "cancellation_type": "cancel",
  "extra_information_needed": false,
  "order": 100,
  "subject": "text",
  "is_active": true,
  "send_to_remote": true,
  "send_to_oms": 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-03-07T03:17:27.008Z",
  "modified_date": "2026-03-07T03:17:27.008Z"
}