# SalesChannelCancellationPlans

## Create payment plan for cancellation

> Creates a payment plan for a cancellation plan in the sales channel

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}}}},"paths":{"/api/channel/{channel_id}/cancellation_plans/{id}/create_payment_plan":{"post":{"summary":"Create payment plan for cancellation","description":"Creates a payment plan for a cancellation plan in the sales channel","tags":["SalesChannelCancellationPlans"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"payment_plan":{"type":"array","items":{"type":"object","required":["transaction_type","order_items","refund_amount"],"properties":{"transaction_type":{"type":"string","description":"Type of the transaction"},"order_items":{"type":"array","items":{"type":"integer"},"description":"List of order item IDs"},"refund_amount":{"type":"number","format":"float","description":"Amount to refund"}}}}},"required":["payment_plan"]}}}},"responses":{"200":{"description":"Successfully created payment plan","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Get cancellation plans that need to be inserted or updated

> Returns a list of cancellation plans inserted or updated in the sales channel

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"plan_type":{"name":"plan_type","in":"query","description":"Type of the cancellation plan","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanType"}},"cancellation_plan_status":{"name":"cancellation_plan_status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanStatus"},"description":"Status of related cancellation plan"},"order_id":{"name":"order_id","in":"query","required":false,"schema":{"type":"integer"},"description":"Order ID"},"order_number":{"name":"order_number","in":"query","description":"Filter by order number","required":false,"schema":{"type":"string"}},"channel_type":{"name":"channel_type","in":"query","description":"Type of the sales channel","required":false,"schema":{"$ref":"#/components/schemas/ChannelType"}},"channel_id__in":{"name":"channel_id__in","in":"query","description":"List of sales channel IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},"invoice_number":{"name":"invoice_number","in":"query","description":"Invoice number associated with the cancellation plan","required":false,"schema":{"type":"string"}},"created_by":{"name":"created_by","in":"query","description":"ID of the user who created the cancellation plan","required":false,"schema":{"type":"integer"}},"modified_by":{"name":"modified_by","in":"query","description":"ID of the user who last modified the cancellation plan","required":false,"schema":{"type":"integer"}},"staff_remote_id":{"name":"staff_remote_id","in":"query","description":"Remote ID of the staff member associated with the cancellation plan","required":false,"schema":{"type":"string"}},"retail_store_remote_id":{"name":"retail_store_remote_id","in":"query","description":"Remote ID of the retail store associated with the cancellation plan","required":false,"schema":{"type":"string"}}},"schemas":{"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"ChannelType":{"type":"string","description":"Type of the channel","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"SalesChannelCancellationPlan":{"$ref":"#/components/schemas/CancellationPlan"},"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}}}},"paths":{"/api/channel/{channel_id}/cancellation_plans/inserts_or_updates/":{"get":{"summary":"Get cancellation plans that need to be inserted or updated","description":"Returns a list of cancellation plans inserted or updated in the sales channel","tags":["SalesChannelCancellationPlans"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/plan_type"},{"$ref":"#/components/parameters/cancellation_plan_status"},{"$ref":"#/components/parameters/order_id"},{"$ref":"#/components/parameters/order_number"},{"$ref":"#/components/parameters/channel_type"},{"$ref":"#/components/parameters/channel_id__in"},{"$ref":"#/components/parameters/invoice_number"},{"$ref":"#/components/parameters/created_by"},{"$ref":"#/components/parameters/modified_by"},{"$ref":"#/components/parameters/staff_remote_id"},{"$ref":"#/components/parameters/retail_store_remote_id"}],"responses":{"200":{"description":"List of cancellation plans to be inserted or updated","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannelCancellationPlan"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}}}}
```

## Retrieve a cancellation plan

> Returns a cancellation plan for a sales channel

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"SalesChannelCancellationPlan":{"$ref":"#/components/schemas/CancellationPlan"},"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}}}},"paths":{"/api/channel/{channel_id}/cancellation_plans/{id}/":{"get":{"summary":"Retrieve a cancellation plan","description":"Returns a cancellation plan for a sales channel","tags":["SalesChannelCancellationPlans"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Cancellation plan for given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelCancellationPlan"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Get cancellation plans that need to be updated

> Returns a list of cancellation plans that updated in the sales channel

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"plan_type":{"name":"plan_type","in":"query","description":"Type of the cancellation plan","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanType"}},"cancellation_plan_status":{"name":"cancellation_plan_status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanStatus"},"description":"Status of related cancellation plan"},"order_id":{"name":"order_id","in":"query","required":false,"schema":{"type":"integer"},"description":"Order ID"},"order_number":{"name":"order_number","in":"query","description":"Filter by order number","required":false,"schema":{"type":"string"}},"channel_type":{"name":"channel_type","in":"query","description":"Type of the sales channel","required":false,"schema":{"$ref":"#/components/schemas/ChannelType"}},"channel_id__in":{"name":"channel_id__in","in":"query","description":"List of sales channel IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},"invoice_number":{"name":"invoice_number","in":"query","description":"Invoice number associated with the cancellation plan","required":false,"schema":{"type":"string"}},"created_by":{"name":"created_by","in":"query","description":"ID of the user who created the cancellation plan","required":false,"schema":{"type":"integer"}},"modified_by":{"name":"modified_by","in":"query","description":"ID of the user who last modified the cancellation plan","required":false,"schema":{"type":"integer"}},"staff_remote_id":{"name":"staff_remote_id","in":"query","description":"Remote ID of the staff member associated with the cancellation plan","required":false,"schema":{"type":"string"}},"retail_store_remote_id":{"name":"retail_store_remote_id","in":"query","description":"Remote ID of the retail store associated with the cancellation plan","required":false,"schema":{"type":"string"}}},"schemas":{"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"ChannelType":{"type":"string","description":"Type of the channel","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"SalesChannelCancellationPlan":{"$ref":"#/components/schemas/CancellationPlan"},"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}}}},"paths":{"/api/channel/{channel_id}/cancellation_plans/updates/":{"get":{"summary":"Get cancellation plans that need to be updated","description":"Returns a list of cancellation plans that updated in the sales channel","tags":["SalesChannelCancellationPlans"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/plan_type"},{"$ref":"#/components/parameters/cancellation_plan_status"},{"$ref":"#/components/parameters/order_id"},{"$ref":"#/components/parameters/order_number"},{"$ref":"#/components/parameters/channel_type"},{"$ref":"#/components/parameters/channel_id__in"},{"$ref":"#/components/parameters/invoice_number"},{"$ref":"#/components/parameters/created_by"},{"$ref":"#/components/parameters/modified_by"},{"$ref":"#/components/parameters/staff_remote_id"},{"$ref":"#/components/parameters/retail_store_remote_id"}],"responses":{"200":{"description":"List of cancellation plans to be updated","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannelCancellationPlan"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}}}}
```

## List cancellation plans for a sales channel

> Returns a list of cancellation plans for a sales channel

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"plan_type":{"name":"plan_type","in":"query","description":"Type of the cancellation plan","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanType"}},"cancellation_plan_status":{"name":"cancellation_plan_status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanStatus"},"description":"Status of related cancellation plan"},"order_id":{"name":"order_id","in":"query","required":false,"schema":{"type":"integer"},"description":"Order ID"},"order_number":{"name":"order_number","in":"query","description":"Filter by order number","required":false,"schema":{"type":"string"}},"channel_type":{"name":"channel_type","in":"query","description":"Type of the sales channel","required":false,"schema":{"$ref":"#/components/schemas/ChannelType"}},"channel_id__in":{"name":"channel_id__in","in":"query","description":"List of sales channel IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},"invoice_number":{"name":"invoice_number","in":"query","description":"Invoice number associated with the cancellation plan","required":false,"schema":{"type":"string"}},"created_by":{"name":"created_by","in":"query","description":"ID of the user who created the cancellation plan","required":false,"schema":{"type":"integer"}},"modified_by":{"name":"modified_by","in":"query","description":"ID of the user who last modified the cancellation plan","required":false,"schema":{"type":"integer"}},"staff_remote_id":{"name":"staff_remote_id","in":"query","description":"Remote ID of the staff member associated with the cancellation plan","required":false,"schema":{"type":"string"}},"retail_store_remote_id":{"name":"retail_store_remote_id","in":"query","description":"Remote ID of the retail store associated with the cancellation plan","required":false,"schema":{"type":"string"}}},"schemas":{"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"ChannelType":{"type":"string","description":"Type of the channel","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"SalesChannelCancellationPlan":{"$ref":"#/components/schemas/CancellationPlan"},"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}}}},"paths":{"/api/channel/{channel_id}/cancellation_plans/":{"get":{"summary":"List cancellation plans for a sales channel","description":"Returns a list of cancellation plans for a sales channel","tags":["SalesChannelCancellationPlans"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/plan_type"},{"$ref":"#/components/parameters/cancellation_plan_status"},{"$ref":"#/components/parameters/order_id"},{"$ref":"#/components/parameters/order_number"},{"$ref":"#/components/parameters/channel_type"},{"$ref":"#/components/parameters/channel_id__in"},{"$ref":"#/components/parameters/invoice_number"},{"$ref":"#/components/parameters/created_by"},{"$ref":"#/components/parameters/modified_by"},{"$ref":"#/components/parameters/staff_remote_id"},{"$ref":"#/components/parameters/retail_store_remote_id"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items"},"next":{"type":"string","format":"uri","nullable":true,"description":"URL of the next page"},"previous":{"type":"string","format":"uri","nullable":true,"description":"URL of the previous page"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannelCancellationPlan"}}}}}}},"401":{"$ref":"#/components/responses/401"}}}}}}
```

## Get cancellation plans that need to be inserted

> Returns a list of cancellation plans that needs to be inserted in the sales channel

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"plan_type":{"name":"plan_type","in":"query","description":"Type of the cancellation plan","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanType"}},"cancellation_plan_status":{"name":"cancellation_plan_status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanStatus"},"description":"Status of related cancellation plan"},"order_id":{"name":"order_id","in":"query","required":false,"schema":{"type":"integer"},"description":"Order ID"},"order_number":{"name":"order_number","in":"query","description":"Filter by order number","required":false,"schema":{"type":"string"}},"channel_type":{"name":"channel_type","in":"query","description":"Type of the sales channel","required":false,"schema":{"$ref":"#/components/schemas/ChannelType"}},"channel_id__in":{"name":"channel_id__in","in":"query","description":"List of sales channel IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},"invoice_number":{"name":"invoice_number","in":"query","description":"Invoice number associated with the cancellation plan","required":false,"schema":{"type":"string"}},"created_by":{"name":"created_by","in":"query","description":"ID of the user who created the cancellation plan","required":false,"schema":{"type":"integer"}},"modified_by":{"name":"modified_by","in":"query","description":"ID of the user who last modified the cancellation plan","required":false,"schema":{"type":"integer"}},"staff_remote_id":{"name":"staff_remote_id","in":"query","description":"Remote ID of the staff member associated with the cancellation plan","required":false,"schema":{"type":"string"}},"retail_store_remote_id":{"name":"retail_store_remote_id","in":"query","description":"Remote ID of the retail store associated with the cancellation plan","required":false,"schema":{"type":"string"}}},"schemas":{"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"ChannelType":{"type":"string","description":"Type of the channel","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"SalesChannelCancellationPlan":{"$ref":"#/components/schemas/CancellationPlan"},"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}}}},"paths":{"/api/channel/{channel_id}/cancellation_plans/inserts/":{"get":{"summary":"Get cancellation plans that need to be inserted","description":"Returns a list of cancellation plans that needs to be inserted in the sales channel","tags":["SalesChannelCancellationPlans"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/plan_type"},{"$ref":"#/components/parameters/cancellation_plan_status"},{"$ref":"#/components/parameters/order_id"},{"$ref":"#/components/parameters/order_number"},{"$ref":"#/components/parameters/channel_type"},{"$ref":"#/components/parameters/channel_id__in"},{"$ref":"#/components/parameters/invoice_number"},{"$ref":"#/components/parameters/created_by"},{"$ref":"#/components/parameters/modified_by"},{"$ref":"#/components/parameters/staff_remote_id"},{"$ref":"#/components/parameters/retail_store_remote_id"}],"responses":{"200":{"description":"List of cancellation plans to be inserted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannelCancellationPlan"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}}}}
```

## Update cancellation plan status

> Updates the status of a cancellation plan in the sales channel

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}}}},"paths":{"/api/channel/{channel_id}/cancellation_plans/{id}/update_status/":{"post":{"summary":"Update cancellation plan status","description":"Updates the status of a cancellation plan in the sales channel","tags":["SalesChannelCancellationPlans"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/CancellationPlanStatus"}}}}}},"responses":{"200":{"description":"Cancellation plan status updated successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/omnitron-openapis/saleschannelcancellationplans.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.