CancellationPlan

Create Payment Plan for Cancellation Plan

post

Creates a payment plan for the cancellation plan

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

Responses

200

Payment plan 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

404

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

application/json

500

Server Error

post

/api/v1/cancellation_plans/{id}/create_payment_plan/

HTTPcURLJavaScriptPython

POST /api/v1/cancellation_plans/{id}/create_payment_plan/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "payment_plan": [
    {
      "transaction_type": "text",
      "order_items": [
        1
      ]
    }
  ]
}

{
  "message": "Payment plan created"
}

Retrieve Cancellation Plan

get

Returns a single cancellation plan

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Cancellation plan details

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get

/api/v1/cancellation_plans/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/cancellation_plans/{id}/ HTTP/1.1
Host: 
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-19T23:13:44.587Z",
      "end": "2026-01-19T23:13:44.587Z"
    },
    "shipping_option_slug": "standard-shipping",
    "created_date": "2026-01-19T23:13:44.587Z",
    "modified_date": "2026-01-19T23:13:44.587Z"
  },
  "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-19T23:13:44.587Z",
      "modified_date": "2026-01-19T23:13:44.587Z"
    }
  ],
  "staff_remote_id": "654321",
  "created_by": {
    "pk": 1,
    "username": "johndoe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "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-19T23:13:44.587Z",
    "modified_date": "2026-01-19T23:13:44.587Z"
  },
  "last_updated_by": {
    "pk": 1,
    "username": "johndoe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "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-19T23:13:44.587Z",
    "modified_date": "2026-01-19T23:13:44.587Z"
  },
  "payment_plan": {},
  "modified_by_id": 1,
  "created_date": "2026-01-19T23:13:44.587Z",
  "modified_date": "2026-01-19T23:13:44.587Z"
}

Get Cancellation Plan Statuses

get

Returns a list of available cancellation plan statuses

Authorizations

Token

AuthorizationstringRequired

Responses

200

List of cancellation plan statuses

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/cancellation_plans/cancellation_plan_statuses/

HTTPcURLJavaScriptPython

GET /api/v1/cancellation_plans/cancellation_plan_statuses/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "cancellation_plan_statuses": {
    "completed": "Completed",
    "waiting": "Waiting"
  }
}

List Cancellation Plans

get

Returns a list of cancellation plans

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

plan_typestring · enumOptional

Type of cancellation plan

Example: cancelPossible values:

statusstring · enumOptional

Filter by the export status.

Example: completedPossible values:

order_idintegerOptional

Order ID

order_numberstringOptional

Filter by order number

Example: ORD123456

channel_typestring · enumOptional

Type of the channel

Example: sales_channelPossible values:

channel_id__ininteger[]Optional

List of sales channel IDs

Example: 1

invoice_numberstringOptional

Invoice number associated with the cancellation plan

Example: INV-123456

invoice_datestring · dateOptional

Date of the invoice associated with the cancellation plan

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

created_byintegerOptional

ID of the user who created the cancellation plan

Example: 1

modified_byintegerOptional

ID of the user who last modified the cancellation plan

Example: 1

staff_remote_idstringOptional

Remote ID of the staff member associated with the cancellation plan

Example: 654321

retail_store_remote_idstringOptional

Remote ID of the retail store associated with the cancellation plan

Example: 123456

related_cancellationplanstringOptional

Filter by related cancellation plan (exact match)

Example: 1

related_cancellation_plan__plan_typestring · enumOptional

Type of cancellation plan

Example: cancelPossible values:

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

pkintegerOptional

Filters by primary key

pk__ininteger[]Optional

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

ordernumberOptional

Filter by order ID.

Example: 123

customer_idintegerOptional

Filter by customer ID.

Example: 123

tagstringOptional

Filter by tag name.

tag__excludestringOptional

Exclude by tag name.

export_formatstring · enumOptional

Export format for the report

Default: csvPossible values:

Responses

200

List of cancellation plans

application/json

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get

/api/v1/cancellation_plans/

HTTPcURLJavaScriptPython

GET /api/v1/cancellation_plans/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-01-19T23:13:44.587Z",
      "modified_date": "2026-01-19T23:13:44.587Z"
    }
  ]
}

Update Cancellation Plan Status

post

Updates the status of a cancellation plan

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

anyOptional

Responses

200

Status updated 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

404

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

application/json

500

Server Error

post

/api/v1/cancellation_plans/{id}/update_status/

HTTPcURLJavaScriptPython

POST /api/v1/cancellation_plans/{id}/update_status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

{
  "message": "Status updated"
}