Sales Channel Cancellation Plans
Creates a payment plan for a cancellation plan in the sales channel
The channel ID of the resource.
5Unique identifier of the resource
1Successfully created payment plan
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
POST /api/channel/{channel_id}/cancellation_plans/{id}/create_payment_plan HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"payment_plan": [
{
"transaction_type": "refund",
"order_items": [
1,
2
],
"refund_amount": 99.99
}
]
}{}Returns a list of cancellation plans inserted or updated in the sales channel
The channel ID of the resource.
5Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Type of cancellation plan
cancelPossible values: Status of the cancellation plan
waitingPossible values: Order ID
Filter by order number
ORD123456Type of the channel
sales_channelPossible values: List of sales channel IDs
1Invoice number associated with the cancellation plan
INV-123456ID of the user who created the cancellation plan
1ID of the user who last modified the cancellation plan
1Remote ID of the staff member associated with the cancellation plan
654321Remote ID of the retail store associated with the cancellation plan
123456List of cancellation plans to be inserted or updated
The date and time when the object was created.
The date and time when the object was last modified.
Primary key of the cancellation plan
Invoice number associated with the cancellation plan
Status of the order item
Amount refunded for shipping
5Status of the cancellation plan
waitingPossible values: Remote ID of the retail store associated with the cancellation plan
123456Refund amount
10Discount refund amount
2Type of cancellation plan
cancelPossible values: Remote ID of the staff member
654321A JSON object to store payment plan details
ID of the user who last modified the cancellation plan
1Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
GET /api/channel/{channel_id}/cancellation_plans/inserts_or_updates/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
[
{
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
}
]Returns a cancellation plan for a sales channel
The channel ID of the resource.
5Unique identifier of the resource
1Cancellation plan for given ID
The date and time when the object was created.
The date and time when the object was last modified.
Primary key of the cancellation plan
Invoice number associated with the cancellation plan
Status of the order item
Amount refunded for shipping
5Status of the cancellation plan
waitingPossible values: Remote ID of the retail store associated with the cancellation plan
123456Refund amount
10Discount refund amount
2Type of cancellation plan
cancelPossible values: Remote ID of the staff member
654321A JSON object to store payment plan details
ID of the user who last modified the cancellation plan
1Unauthorized Access
The given resource or object was not found or does not exist.
GET /api/channel/{channel_id}/cancellation_plans/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"pk": 1,
"order": {
"pk": 1,
"number": "ORDER12345",
"channel": 1,
"customer": 1,
"date_placed": "2024-11-20T11:22:23.702774Z",
"extra_field": {
"special_note": "Handle with care"
},
"payment_option": 1,
"payment_option_slug": "credit-card",
"bin_number": "123456",
"installment": 1,
"installment_count": 6,
"installment_interest_amount": 50,
"cargo_company": 1,
"is_send": false,
"delivery_type": "next_day",
"cancellation_info": {
"reason": "Customer requested cancellation"
},
"cancel_status": "cancelled",
"shipping_interest_amount": 10,
"external_status": 1,
"client_type": "default",
"carrier_shipping_code": "TRACK12345",
"segment": "premium",
"checkout_provider_id": 12345,
"status": 200,
"currency": "try",
"amount": 1000,
"discount_amount": 50,
"shipping_amount": 20,
"shipping_tax_rate": 18,
"refund_amount": 100,
"discount_refund_amount": 10,
"shipping_refund_amount": 5,
"invoice_number": "INV123456",
"invoice_date": "2024-11-21T11:22:23.702774Z",
"e_archive_url": "https://earchive.example.com/invoice/123",
"tracking_number": "TRACK12345",
"defined_tracking_url": "https://tracking.example.com/track/123",
"shipping_company": "yurtici",
"remote_addr": "192.168.0.1",
"has_gift_box": false,
"gift_box_note": "Happy Birthday!",
"language_code": "en",
"notes": "Leave at the front door.",
"delivery_range": {
"start": "2026-01-01T00:00:00.000Z",
"end": "2026-01-01T00:00:00.000Z"
},
"shipping_option_slug": "standard-shipping",
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
},
"invoice_number": "text",
"order_previous_status": "cancellation_waiting",
"shipping_refund_amount": 5,
"status": "waiting",
"retail_store_remote_id": "123456",
"refund_amount": 10,
"discount_refund_amount": 2,
"plan_type": "cancel",
"cancellationplanorderitem_set": [
{
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
}
],
"staff_remote_id": "654321",
"created_by": {
"pk": 1,
"username": "johndoe",
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@test.com",
"is_active": true,
"is_staff": false,
"is_superuser": false,
"date_joined": "2023-10-01T12:00:00Z",
"last_login": "2023-10-01T12:00:00Z",
"groups": [
1
],
"can_read_sensitive_data": false,
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
},
"last_updated_by": {
"pk": 1,
"username": "johndoe",
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@test.com",
"is_active": true,
"is_staff": false,
"is_superuser": false,
"date_joined": "2023-10-01T12:00:00Z",
"last_login": "2023-10-01T12:00:00Z",
"groups": [
1
],
"can_read_sensitive_data": false,
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
},
"payment_plan": {},
"modified_by_id": 1,
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
}Returns a list of cancellation plans that updated in the sales channel
The channel ID of the resource.
5Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Type of cancellation plan
cancelPossible values: Status of the cancellation plan
waitingPossible values: Order ID
Filter by order number
ORD123456Type of the channel
sales_channelPossible values: List of sales channel IDs
1Invoice number associated with the cancellation plan
INV-123456ID of the user who created the cancellation plan
1ID of the user who last modified the cancellation plan
1Remote ID of the staff member associated with the cancellation plan
654321Remote ID of the retail store associated with the cancellation plan
123456List of cancellation plans to be updated
The date and time when the object was created.
The date and time when the object was last modified.
Primary key of the cancellation plan
Invoice number associated with the cancellation plan
Status of the order item
Amount refunded for shipping
5Status of the cancellation plan
waitingPossible values: Remote ID of the retail store associated with the cancellation plan
123456Refund amount
10Discount refund amount
2Type of cancellation plan
cancelPossible values: Remote ID of the staff member
654321A JSON object to store payment plan details
ID of the user who last modified the cancellation plan
1Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
GET /api/channel/{channel_id}/cancellation_plans/updates/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
[
{
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
}
]Returns a list of cancellation plans for a sales channel
The channel ID of the resource.
5Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Type of cancellation plan
cancelPossible values: Status of the cancellation plan
waitingPossible values: Order ID
Filter by order number
ORD123456Type of the channel
sales_channelPossible values: List of sales channel IDs
1Invoice number associated with the cancellation plan
INV-123456ID of the user who created the cancellation plan
1ID of the user who last modified the cancellation plan
1Remote ID of the staff member associated with the cancellation plan
654321Remote ID of the retail store associated with the cancellation plan
123456Successful response
Total number of items
URL of the next page
URL of the previous page
Unauthorized Access
GET /api/channel/{channel_id}/cancellation_plans/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 1,
"next": "https://example.com",
"previous": "https://example.com",
"results": [
{
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
}
]
}Returns a list of cancellation plans that needs to be inserted in the sales channel
The channel ID of the resource.
5Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Type of cancellation plan
cancelPossible values: Status of the cancellation plan
waitingPossible values: Order ID
Filter by order number
ORD123456Type of the channel
sales_channelPossible values: List of sales channel IDs
1Invoice number associated with the cancellation plan
INV-123456ID of the user who created the cancellation plan
1ID of the user who last modified the cancellation plan
1Remote ID of the staff member associated with the cancellation plan
654321Remote ID of the retail store associated with the cancellation plan
123456List of cancellation plans to be inserted
The date and time when the object was created.
The date and time when the object was last modified.
Primary key of the cancellation plan
Invoice number associated with the cancellation plan
Status of the order item
Amount refunded for shipping
5Status of the cancellation plan
waitingPossible values: Remote ID of the retail store associated with the cancellation plan
123456Refund amount
10Discount refund amount
2Type of cancellation plan
cancelPossible values: Remote ID of the staff member
654321A JSON object to store payment plan details
ID of the user who last modified the cancellation plan
1Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
GET /api/channel/{channel_id}/cancellation_plans/inserts/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
[
{
"created_date": "2026-01-01T00:00:00.000Z",
"modified_date": "2026-01-01T00:00:00.000Z"
}
]Updates the status of a cancellation plan in the sales channel
The channel ID of the resource.
5Unique identifier of the resource
1Status of the cancellation plan
waitingPossible values: Cancellation plan status updated successfully
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
POST /api/channel/{channel_id}/cancellation_plans/{id}/update_status/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"status": "waiting"
}{}Last updated
Was this helpful?