SalesChannelCancellationRequests

Reject a cancellation request

post

Reject an existing cancellation request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Cancellation request rejected 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

post

/api/channel/{channel_id}/cancellation_requests/{id}/reject/

POST /api/channel/{channel_id}/cancellation_requests/{id}/reject/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "order_item": 1,
  "reason": 1,
  "description": "text",
  "cancellation_type": "refund",
  "status": "rejected",
  "iban": "text",
  "holder_name": "text",
  "easy_return": {
    "id": 1,
    "shipping_company": "yurtici",
    "code": "EASYRETURN123",
    "start_date": "2026-06-09T05:35:57.737Z",
    "end_date": "2026-06-09T05:35:57.737Z",
    "max_count": 1,
    "status": "active",
    "raw_request": "text",
    "raw_response": "text",
    "tracking_number": "123456789",
    "tracking_url": "https://example.com/track/123456789",
    "pickup_date": {},
    "created_date": "2026-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "created_date": "2026-06-09T05:35:57.737Z",
  "modified_date": "2026-06-09T05:35:57.737Z",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  "attributes_kwargs": {
    "key1": "value1",
    "key2": "value2"
  },
  "localized_attributes": {
    "name": {
      "en": "English",
      "es": "Spanish"
    }
  },
  "localized_attributes_kwargs": {
    "key": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Retrieve a cancellation request

get

Get detailed information about a specific cancellation request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Cancellation request for given ID

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

get

/api/channel/{channel_id}/cancellation_requests/{id}/

GET /api/channel/{channel_id}/cancellation_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "order_item": 1,
  "reason": 1,
  "description": "text",
  "cancellation_type": "refund",
  "status": "rejected",
  "iban": "text",
  "holder_name": "text",
  "easy_return": {
    "id": 1,
    "shipping_company": "yurtici",
    "code": "EASYRETURN123",
    "start_date": "2026-06-09T05:35:57.737Z",
    "end_date": "2026-06-09T05:35:57.737Z",
    "max_count": 1,
    "status": "active",
    "raw_request": "text",
    "raw_response": "text",
    "tracking_number": "123456789",
    "tracking_url": "https://example.com/track/123456789",
    "pickup_date": {},
    "created_date": "2026-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "created_date": "2026-06-09T05:35:57.737Z",
  "modified_date": "2026-06-09T05:35:57.737Z",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  "attributes_kwargs": {
    "key1": "value1",
    "key2": "value2"
  },
  "localized_attributes": {
    "name": {
      "en": "English",
      "es": "Spanish"
    }
  },
  "localized_attributes_kwargs": {
    "key": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Update a cancellation request

put

Update an existing cancellation request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

statusstring · enumOptional

Status of the cancellation request.

Example: waitingPossible values:

descriptionstring · nullableOptional

Description of the cancellation request

ibanstring · nullableOptional

IBAN for refund

holder_namestring · nullableOptional

Name of the account holder

cancellation_typestring · enumOptional

Type of cancellation

Example: cancelPossible values:

quantityinteger · min: 1 · nullableOptional

Quantity of items to be cancelled

fully_refund_as_loyalty_moneybooleanOptional

Flag to indicate if the refund should be processed as loyalty money

Default: false

reasonintegerOptional

Related cancellation reason ID

Example: 1

order_itemintegerOptional

Related order item ID

Example: 1

Responses

200

Cancellation request 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

put

/api/channel/{channel_id}/cancellation_requests/{id}/

PUT /api/channel/{channel_id}/cancellation_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "status": "waiting",
  "description": "text",
  "iban": "text",
  "holder_name": "text",
  "cancellation_type": "cancel",
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "reason": 1,
  "order_item": 1
}

{
  "id": 1,
  "order_item": 1,
  "reason": 1,
  "description": "text",
  "cancellation_type": "refund",
  "status": "rejected",
  "iban": "text",
  "holder_name": "text",
  "easy_return": {
    "id": 1,
    "shipping_company": "yurtici",
    "code": "EASYRETURN123",
    "start_date": "2026-06-09T05:35:57.737Z",
    "end_date": "2026-06-09T05:35:57.737Z",
    "max_count": 1,
    "status": "active",
    "raw_request": "text",
    "raw_response": "text",
    "tracking_number": "123456789",
    "tracking_url": "https://example.com/track/123456789",
    "pickup_date": {},
    "created_date": "2026-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "created_date": "2026-06-09T05:35:57.737Z",
  "modified_date": "2026-06-09T05:35:57.737Z",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  "attributes_kwargs": {
    "key1": "value1",
    "key2": "value2"
  },
  "localized_attributes": {
    "name": {
      "en": "English",
      "es": "Spanish"
    }
  },
  "localized_attributes_kwargs": {
    "key": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Delete a cancellation request

delete

Delete an existing cancellation request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Cancellation request deleted successfully

401

Unauthorized Access

application/json

404

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

application/json

delete

/api/channel/{channel_id}/cancellation_requests/{id}/

DELETE /api/channel/{channel_id}/cancellation_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Partial update a cancellation request

patch

Partial update an existing cancellation request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

statusstring · enumOptional

Status of the cancellation request.

Example: waitingPossible values:

descriptionstring · nullableOptional

Description of the cancellation request

ibanstring · nullableOptional

IBAN for refund

holder_namestring · nullableOptional

Name of the account holder

cancellation_typestring · enumOptional

Type of cancellation

Example: cancelPossible values:

quantityinteger · min: 1 · nullableOptional

Quantity of items to be cancelled

fully_refund_as_loyalty_moneybooleanOptional

Flag to indicate if the refund should be processed as loyalty money

Default: false

reasonintegerOptional

Related cancellation reason ID

Example: 1

order_itemintegerOptional

Related order item ID

Example: 1

Responses

200

Cancellation request 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

patch

/api/channel/{channel_id}/cancellation_requests/{id}/

PATCH /api/channel/{channel_id}/cancellation_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "status": "waiting",
  "description": "text",
  "iban": "text",
  "holder_name": "text",
  "cancellation_type": "cancel",
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "reason": 1,
  "order_item": 1
}

{
  "id": 1,
  "order_item": 1,
  "reason": 1,
  "description": "text",
  "cancellation_type": "refund",
  "status": "rejected",
  "iban": "text",
  "holder_name": "text",
  "easy_return": {
    "id": 1,
    "shipping_company": "yurtici",
    "code": "EASYRETURN123",
    "start_date": "2026-06-09T05:35:57.737Z",
    "end_date": "2026-06-09T05:35:57.737Z",
    "max_count": 1,
    "status": "active",
    "raw_request": "text",
    "raw_response": "text",
    "tracking_number": "123456789",
    "tracking_url": "https://example.com/track/123456789",
    "pickup_date": {},
    "created_date": "2026-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "created_date": "2026-06-09T05:35:57.737Z",
  "modified_date": "2026-06-09T05:35:57.737Z",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  "attributes_kwargs": {
    "key1": "value1",
    "key2": "value2"
  },
  "localized_attributes": {
    "name": {
      "en": "English",
      "es": "Spanish"
    }
  },
  "localized_attributes_kwargs": {
    "key": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Retrieve a cancellation request

get

Get detailed information about a specific cancellation request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Cancellation request for given ID

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

get

/api/channel/{channel_id}/cancellation_requests/{id}/detailed/

GET /api/channel/{channel_id}/cancellation_requests/{id}/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "order_item": {
    "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-06-09T05:35:57.737Z",
        "end": "2026-06-09T05:35:57.737Z"
      },
      "shipping_option_slug": "standard-shipping",
      "created_date": "2026-06-09T05:35:57.737Z",
      "modified_date": "2026-06-09T05:35:57.737Z"
    },
    "product": {
      "id": 1,
      "name": "text",
      "base_code": "text",
      "sku": "text",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "description": "text",
      "brand": 1,
      "erp_categories": [
        1
      ],
      "tax_rate": 1,
      "weight": 1,
      "product_type": "pre_product",
      "productization_date": "2026-06-09T05:35:57.737Z",
      "data_source": 1,
      "created_date": "2026-06-09T05:35:57.737Z",
      "modified_date": "2026-06-09T05:35:57.737Z",
      "is_active": true,
      "attribute_set": 1,
      "parent": 1,
      "group_products": [
        1
      ],
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "listing_code": "text",
      "is_seller_product": false,
      "custom_attribute_set": 1
    },
    "price_list": {
      "pk": 1,
      "name": "Standard Price List",
      "code": "shop_price_list",
      "currency": "try",
      "is_auto_sync": true,
      "created_date": "2026-06-09T05:35:57.737Z",
      "modified_date": "2026-06-09T05:35:57.737Z"
    },
    "stock_list": {
      "pk": 1,
      "name": "text",
      "code": "text",
      "is_auto_sync": false,
      "created_date": "2026-06-09T05:35:57.737Z",
      "modified_date": "2026-06-09T05:35:57.737Z"
    },
    "status": "waiting",
    "price_currency": "try",
    "price": 100,
    "tax_rate": 18,
    "shipping_company": "yurtici",
    "shipment_code": "text",
    "cancel_status": "waiting",
    "is_tradable": true,
    "installment_interest_amount": 1,
    "benefitapplicant_set": [
      {
        "created_date": "2026-06-09T05:35:57.737Z",
        "modified_date": "2026-06-09T05:35:57.737Z"
      }
    ],
    "external_status": {
      "pk": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Shipped",
      "code": "SHIPPED",
      "modified_date": "2021-07-07T14:00:00Z",
      "created_date": "2021-07-07T14:00:00Z"
    },
    "datasource": {
      "pk": 1,
      "name": "Example Data Source",
      "slug": "example-data-source",
      "stock_list": 1,
      "price_list": 1,
      "is_active": true,
      "token": "text",
      "conf": {},
      "commission": 5,
      "maturity": 1,
      "supplier_code": "text",
      "supplier_detail": {},
      "easy_return_detail": {},
      "extras": {},
      "data_source_type": "unified",
      "created_date": "2026-06-09T05:35:57.737Z",
      "modified_date": "2026-06-09T05:35:57.737Z"
    },
    "tracking_url": "https://example.com",
    "shipping_option_group": {
      "pk": 1,
      "amount": 0,
      "tax_rate": 18,
      "shipping_option_slug": "text",
      "created_date": "2026-06-09T05:35:57.737Z",
      "modified_date": "2026-06-09T05:35:57.737Z"
    },
    "forced_refund": true,
    "extra_field": {},
    "created_date": "2026-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  },
  "reason": {
    "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-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z"
  },
  "description": "text",
  "cancellation_type": "refund",
  "status": "waiting",
  "iban": "text",
  "holder_name": "text",
  "easy_return": {
    "id": 1,
    "shipping_company": "yurtici",
    "code": "EASYRETURN123",
    "start_date": "2026-06-09T05:35:57.737Z",
    "end_date": "2026-06-09T05:35:57.737Z",
    "max_count": 1,
    "status": "active",
    "raw_request": "text",
    "raw_response": "text",
    "tracking_number": "123456789",
    "tracking_url": "https://example.com/track/123456789",
    "pickup_date": {},
    "created_date": "2026-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "customer": {
    "pk": 123,
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "+123456789",
    "is_active": true,
    "channel_code": "CH123",
    "erp_code": "ERP456",
    "attributes": {
      "logged_ip": "127.0.0.1",
      "register_client_type": "default"
    },
    "attribute_kwargs": {},
    "localized_attributes": {},
    "localized_attribute_kwargs": {},
    "extra_field": {
      "key1": "value1",
      "key2": 100
    },
    "email_allowed": true,
    "sms_allowed": false,
    "call_allowed": true,
    "date_joined": "2023-01-15T10:30:00Z",
    "gender": "female",
    "user_type": "guest",
    "date_of_birth": "1985-08-25",
    "channel": 5
  }
}

List cancellation requests

get

Get a list of cancellation requests for a sales channel

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

pk__ininteger[]Optional

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

statusstring · enumOptional

Status of the cancellation request.

Example: rejectedPossible values:

numberstringOptional

Order number (case-insensitive)

date_placedstring · date-timeOptional

Order number (case-insensitive)

date_placed__gtestring · date-timeOptional

date_placed__gtstring · date-timeOptional

Order placed after this date

date_placed__ltstring · date-timeOptional

date_placed__ltestring · date-timeOptional

date_placed__date__gtstring · dateOptional

date_placed__date__gtestring · dateOptional

date_placed__date__ltstring · dateOptional

date_placed__date__ltestring · dateOptional

skustringOptional

Product SKU (case-insensitive)

channelintegerOptional

ID of the channel the customer belongs to

Example: 5

customer_first_namestringOptional

Customer's first name (case-insensitive)

customer_last_namestringOptional

Customer's last name (case-insensitive)

customer_emailstring · emailOptional

Customer's email (case-insensitive)

order_idintegerOptional

Order ID

cancellation_plan_statusstring · enumOptional

Status of the cancellation plan

Example: waitingPossible values:

easy_return_codestringOptional

Easy return code (case-insensitive)

tracking_numberstringOptional

Tracking number (case-insensitive)

Responses

200

List of cancellation requests

application/json

400

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

application/json

401

Unauthorized Access

application/json

get

/api/channel/{channel_id}/cancellation_requests/

GET /api/channel/{channel_id}/cancellation_requests/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2026-06-09T05:35:57.737Z",
      "modified_date": "2026-06-09T05:35:57.737Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "attributes": {
        "key1": "value1",
        "key2": "value2"
      },
      "attributes_kwargs": {
        "key1": "value1",
        "key2": "value2"
      },
      "localized_attributes": {
        "name": {
          "en": "English",
          "es": "Spanish"
        }
      },
      "localized_attributes_kwargs": {
        "key": {
          "key1": "value1",
          "key2": "value2"
        }
      }
    }
  ]
}

Create a cancellation request

post

Create a new cancellation request for a sales channel

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

order_itemintegerRequired

Related order item ID

Example: 1

reasonintegerRequired

Related cancellation reason ID

Example: 1

descriptionstring · nullableOptional

Description of the cancellation request

cancellation_typestring · enumRequired

Type of cancellation

Example: cancelPossible values:

ibanstring · nullableOptional

IBAN for refund

holder_namestring · nullableOptional

Name of the account holder

quantityinteger · min: 1 · nullableOptional

Quantity of items to be cancelled

Responses

201

Cancellation request created successfully

application/json

created_datestring · date-timeRead-onlyRequired

The date and time when the object was created.

modified_datestring · date-timeRequired

The date and time when the object was last modified.

uuidstring · uuidRead-onlyOptional

Unique UUID identifier

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

attributesobjectOptional

A JSON object to store various attributes of the entity.

Example: {"key1":"value1","key2":"value2"}

attributes_kwargsobjectOptional

A JSON object to store additional attribute keyword arguments.

Example: {"key1":"value1","key2":"value2"}

localized_attributesobjectOptional

A JSON object to store localized attributes.

Example: {"name":{"en":"English","es":"Spanish"}}

localized_attributes_kwargsobjectOptional

A JSON object to store localized attributes keyword arguments.

Example: {"key":{"key1":"value1","key2":"value2"}}

idinteger · int64Read-onlyRequired

Cancellation Request ID

order_itemintegerRequired

Related order item ID

Example: 1

reasonintegerRequired

Related cancellation reason ID

Example: 1

descriptionstring · nullableOptional

Description of the cancellation request

cancellation_typestring · enumRequired

Type of cancellation

Example: refundPossible values:

statusstring · enumRequired

Status of the cancellation request.

Example: rejectedPossible values:

ibanstring · nullableOptional

IBAN for refund

holder_namestring · nullableOptional

Name of the account holder

quantityinteger · min: 1 · nullableOptional

Quantity of items to be cancelled

fully_refund_as_loyalty_moneybooleanOptional

Flag to indicate if the refund should be processed as loyalty money

Default: false

400

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

application/json

401

Unauthorized Access

application/json

403

Forbidden

post

/api/channel/{channel_id}/cancellation_requests/

POST /api/channel/{channel_id}/cancellation_requests/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "order_item": 1,
  "reason": 1,
  "description": "text",
  "cancellation_type": "cancel",
  "iban": "text",
  "holder_name": "text",
  "quantity": 1
}

{
  "id": 1,
  "order_item": 1,
  "reason": 1,
  "description": "text",
  "cancellation_type": "refund",
  "status": "rejected",
  "iban": "text",
  "holder_name": "text",
  "easy_return": {
    "id": 1,
    "shipping_company": "yurtici",
    "code": "EASYRETURN123",
    "start_date": "2026-06-09T05:35:57.737Z",
    "end_date": "2026-06-09T05:35:57.737Z",
    "max_count": 1,
    "status": "active",
    "raw_request": "text",
    "raw_response": "text",
    "tracking_number": "123456789",
    "tracking_url": "https://example.com/track/123456789",
    "pickup_date": {},
    "created_date": "2026-06-09T05:35:57.737Z",
    "modified_date": "2026-06-09T05:35:57.737Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "quantity": 1,
  "fully_refund_as_loyalty_money": false,
  "created_date": "2026-06-09T05:35:57.737Z",
  "modified_date": "2026-06-09T05:35:57.737Z",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  "attributes_kwargs": {
    "key1": "value1",
    "key2": "value2"
  },
  "localized_attributes": {
    "name": {
      "en": "English",
      "es": "Spanish"
    }
  },
  "localized_attributes_kwargs": {
    "key": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

List cancellation requests with detailed information

get

Get a list of cancellation requests for a sales channel with detailed information

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

pk__ininteger[]Optional

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

statusstring · enumOptional

Status of the cancellation request.

Example: rejectedPossible values:

numberstringOptional

Order number (case-insensitive)

date_placed__gtestring · date-timeOptional

date_placed__gtstring · date-timeOptional

Order placed after this date

date_placed__ltstring · date-timeOptional

date_placed__ltestring · date-timeOptional

date_placed__date__gtstring · dateOptional

date_placed__date__gtestring · dateOptional

date_placed__date__ltstring · dateOptional

date_placed__date__ltestring · dateOptional

skustringOptional

Product SKU (case-insensitive)

channelintegerOptional

ID of the channel the customer belongs to

Example: 5

customer_first_namestringOptional

Customer's first name (case-insensitive)

customer_last_namestringOptional

Customer's last name (case-insensitive)

customer_emailstring · emailOptional

Customer's email (case-insensitive)

order_idintegerOptional

Order ID

cancellation_plan_statusstring · enumOptional

Status of the cancellation plan

Example: waitingPossible values:

easy_return_codestringOptional

Easy return code (case-insensitive)

tracking_numberstringOptional

Tracking number (case-insensitive)

Responses

200

List of cancellation requests

application/json

400

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

application/json

401

Unauthorized Access

application/json

get

/api/channel/{channel_id}/cancellation_requests/detailed

GET /api/channel/{channel_id}/cancellation_requests/detailed HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "id": 1,
      "order_item": {
        "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-06-09T05:35:57.737Z",
            "end": "2026-06-09T05:35:57.737Z"
          },
          "shipping_option_slug": "standard-shipping",
          "created_date": "2026-06-09T05:35:57.737Z",
          "modified_date": "2026-06-09T05:35:57.737Z"
        },
        "product": {
          "id": 1,
          "name": "text",
          "base_code": "text",
          "sku": "text",
          "uuid": "550e8400-e29b-41d4-a716-446655440000",
          "description": "text",
          "brand": 1,
          "erp_categories": [
            1
          ],
          "tax_rate": 1,
          "weight": 1,
          "product_type": "pre_product",
          "productization_date": "2026-06-09T05:35:57.737Z",
          "data_source": 1,
          "created_date": "2026-06-09T05:35:57.737Z",
          "modified_date": "2026-06-09T05:35:57.737Z",
          "is_active": true,
          "attribute_set": 1,
          "parent": 1,
          "group_products": [
            1
          ],
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "listing_code": "text",
          "is_seller_product": false,
          "custom_attribute_set": 1
        },
        "price_list": {
          "pk": 1,
          "name": "Standard Price List",
          "code": "shop_price_list",
          "currency": "try",
          "is_auto_sync": true,
          "created_date": "2026-06-09T05:35:57.737Z",
          "modified_date": "2026-06-09T05:35:57.737Z"
        },
        "stock_list": {
          "pk": 1,
          "name": "text",
          "code": "text",
          "is_auto_sync": false,
          "created_date": "2026-06-09T05:35:57.737Z",
          "modified_date": "2026-06-09T05:35:57.737Z"
        },
        "status": "waiting",
        "price_currency": "try",
        "price": 100,
        "tax_rate": 18,
        "shipping_company": "yurtici",
        "shipment_code": "text",
        "cancel_status": "waiting",
        "is_tradable": true,
        "installment_interest_amount": 1,
        "benefitapplicant_set": [
          {
            "created_date": "2026-06-09T05:35:57.737Z",
            "modified_date": "2026-06-09T05:35:57.737Z"
          }
        ],
        "external_status": {
          "pk": 1,
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Shipped",
          "code": "SHIPPED",
          "modified_date": "2021-07-07T14:00:00Z",
          "created_date": "2021-07-07T14:00:00Z"
        },
        "datasource": {
          "pk": 1,
          "name": "Example Data Source",
          "slug": "example-data-source",
          "stock_list": 1,
          "price_list": 1,
          "is_active": true,
          "token": "text",
          "conf": {},
          "commission": 5,
          "maturity": 1,
          "supplier_code": "text",
          "supplier_detail": {},
          "easy_return_detail": {},
          "extras": {},
          "data_source_type": "unified",
          "created_date": "2026-06-09T05:35:57.737Z",
          "modified_date": "2026-06-09T05:35:57.737Z"
        },
        "tracking_url": "https://example.com",
        "shipping_option_group": {
          "pk": 1,
          "amount": 0,
          "tax_rate": 18,
          "shipping_option_slug": "text",
          "created_date": "2026-06-09T05:35:57.737Z",
          "modified_date": "2026-06-09T05:35:57.737Z"
        },
        "forced_refund": true,
        "extra_field": {},
        "created_date": "2026-06-09T05:35:57.737Z",
        "modified_date": "2026-06-09T05:35:57.737Z",
        "attributes": {
          "key1": "value1",
          "key2": "value2"
        },
        "attributes_kwargs": {
          "key1": "value1",
          "key2": "value2"
        },
        "localized_attributes": {
          "name": {
            "en": "English",
            "es": "Spanish"
          }
        },
        "localized_attributes_kwargs": {
          "key": {
            "key1": "value1",
            "key2": "value2"
          }
        }
      },
      "reason": {
        "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-06-09T05:35:57.737Z",
        "modified_date": "2026-06-09T05:35:57.737Z"
      },
      "description": "text",
      "cancellation_type": "refund",
      "status": "waiting",
      "iban": "text",
      "holder_name": "text",
      "easy_return": {
        "id": 1,
        "shipping_company": "yurtici",
        "code": "EASYRETURN123",
        "start_date": "2026-06-09T05:35:57.737Z",
        "end_date": "2026-06-09T05:35:57.737Z",
        "max_count": 1,
        "status": "active",
        "raw_request": "text",
        "raw_response": "text",
        "tracking_number": "123456789",
        "tracking_url": "https://example.com/track/123456789",
        "pickup_date": {},
        "created_date": "2026-06-09T05:35:57.737Z",
        "modified_date": "2026-06-09T05:35:57.737Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "quantity": 1,
      "fully_refund_as_loyalty_money": false,
      "channel": {
        "id": 1,
        "name": "Commerce Channel",
        "catalog": 1,
        "channel_type": "web",
        "conf": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "category_tree": "text",
        "is_active": true,
        "schema": {},
        "created_date": "2024-11-20T11:22:23.702774Z",
        "modified_date": "2024-11-20T11:22:23.702774Z"
      },
      "customer": {
        "pk": 123,
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Doe",
        "phone_number": "+123456789",
        "is_active": true,
        "channel_code": "CH123",
        "erp_code": "ERP456",
        "attributes": {
          "logged_ip": "127.0.0.1",
          "register_client_type": "default"
        },
        "attribute_kwargs": {},
        "localized_attributes": {},
        "localized_attribute_kwargs": {},
        "extra_field": {
          "key1": "value1",
          "key2": 100
        },
        "email_allowed": true,
        "sms_allowed": false,
        "call_allowed": true,
        "date_joined": "2023-01-15T10:30:00Z",
        "gender": "female",
        "user_type": "guest",
        "date_of_birth": "1985-08-25",
        "channel": 5
      }
    }
  ]
}

PreviousSalesChannelAttributeSchemas NextSalesChannelMarketPlaceAttributeValue

Last updated 5 months ago

Was this helpful?