Cancellation Requests
Reject a specific cancellation request.
Unique identifier of the resource
1Cancellation request rejected successfully
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Retrieve a specific cancellation request by ID.
Unique identifier of the resource
1Cancellation request retrieved successfully
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Retrieve a specific cancellation request by ID with detailed information.
Unique identifier of the resource
1Detailed cancellation request retrieved successfully
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Retrieve tags associated with a specific Cancellation Request by ID
Unique identifier of the resource
1Tags retrieved successfully
tag1Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Add tags to a specific Cancellation Request by ID
Unique identifier of the resource
1Tag key to add to the object.
Tags added successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Add multiple tags to a specific Cancellation Request by ID
Unique identifier of the resource
1List of tag keys to add to the objects.
Tags added successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Remove tags to a specific Cancellation Request by ID
Unique identifier of the resource
1Tag key to add to the object.
Tags removed successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Remove multiple tags to a specific Cancellation Request by ID
Unique identifier of the resource
1List of tag keys to add to the objects.
Tags removed successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
List all cancellation requests with the ability to filter by tags and other parameters. 'key' parameter is required in query param or body.
Tag to filter cancellation requests by.
cancellation requests successfully listed
Unauthorized Access
Server Error
List all cancellation requests with the ability to exclude by tags and other parameters. 'key' parameter is required in query param or body.
Tag to filter cancellation requests by.
cancellation requests successfully listed
Unauthorized Access
Server Error
Bulk add tags to cancellation requests.
List of object IDs to which tags will be added.
List of tag keys to add to the objects.
Successfully added tags to cancellation requests
No content
Unauthorized Access
Server Error
No content
Bulk remove tags from cancellation requests.
List of object IDs to which tags will be added.
List of tag keys to add to the objects.
Successfully removed tags from cancellation requests
No content
Unauthorized Access
Server Error
No content
Retrieve a paginated list of all cancellation requests with filtering support.
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by UUID.
123e4567-e89b-12d3-a456-426614174000Filters by primary key
Filter by primary key greater than a specific value.
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filter by multiple primary key values (comma-separated list of integers)
Filter by cancellation type
Status of the cancellation request.
rejectedPossible values: Order number (case-insensitive)
Order number (case-insensitive)
Product SKU (case-insensitive)
ID of the channel the customer belongs to
5Customer's first name (case-insensitive)
Customer's last name (case-insensitive)
Customer's email (case-insensitive)
Order ID
Status of the cancellation plan
waitingPossible values: Easy return code (case-insensitive)
Tracking number (case-insensitive)
Currency type for the price list.
tryPossible values: Filter by shipping option slug (case-insensitive)
Filter by order item ID.
Filter by cancellation reason ID
Filter by product description.
Filter by IBAN
Filter by holder name
Filter by easy return ID
Filter by quantity
Filter by fully refund as loyalty money flag
A paginated list of cancellation requests.
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Create a new cancellation request for an order item.
Related order item ID
1Related cancellation reason ID
1Description of the cancellation request
Type of cancellation
cancelPossible values: IBAN for refund
Name of the account holder
Quantity of items to be cancelled
Cancellation request created successfully.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Retrieve a paginated list of cancellation requests with detailed information. Use export_format parameter to get a different set of fields optimized for data export purposes.
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Export format for the report
csvPossible values: Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilters by primary key
Filter by primary key greater than a specific value.
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filter by multiple primary key values (comma-separated list of integers)
Filter by cancellation type
Status of the cancellation request.
rejectedPossible values: Order number (case-insensitive)
Order number (case-insensitive)
Product SKU (case-insensitive)
ID of the channel the customer belongs to
5Customer's first name (case-insensitive)
Customer's last name (case-insensitive)
Customer's email (case-insensitive)
Order ID
Status of the cancellation plan
waitingPossible values: Easy return code (case-insensitive)
Tracking number (case-insensitive)
Currency type for the price list.
tryPossible values: Filter by shipping option slug (case-insensitive)
Filter by order item ID.
Filter by cancellation reason ID
Filter by product description.
Filter by IBAN
Filter by holder name
Filter by easy return ID
Filter by quantity
Filter by fully refund as loyalty money flag
A paginated list of detailed cancellation requests.
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Update an existing cancellation request.
Unique identifier of the resource
1Status of the cancellation request.
waitingPossible values: Description of the cancellation request
IBAN for refund
Name of the account holder
Type of cancellation
cancelPossible values: Quantity of items to be cancelled
Flag to indicate if the refund should be processed as loyalty money
falseRelated cancellation reason ID
1Related order item ID
1Cancellation request updated successfully.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Partially update an existing cancellation request.
Unique identifier of the resource
1Status of the cancellation request.
waitingPossible values: Description of the cancellation request
IBAN for refund
Name of the account holder
Type of cancellation
cancelPossible values: Quantity of items to be cancelled
Flag to indicate if the refund should be processed as loyalty money
falseRelated cancellation reason ID
1Related order item ID
1Cancellation request partially updated successfully.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Forbidden
The given resource or object was not found or does not exist.
Server Error
Last updated
Was this helpful?