# SalesChannelOrders

## Bulk replace products in an order

> Replace multiple products in an order with the specified ID

```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":{"GetOrderBulkReplaceProduct":{"$ref":"#/components/schemas/BulkReplaceProduct"},"BulkReplaceProduct":{"type":"array","description":"List of order items for product replacement","items":{"$ref":"#/components/schemas/BulkReplaceProductItem"}},"BulkReplaceProductItem":{"properties":{"order_item":{"type":"integer","description":"Order item ID for product replacement"},"new_product_sku":{"type":"string","description":"New product SKU for replacement"}}},"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/bulk_replace_product/":{"post":{"tags":["SalesChannelOrders"],"summary":"Bulk replace products in an order","description":"Replace multiple products in an order with the specified ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderBulkReplaceProduct"}}}},"responses":{"200":{"description":"Products successfully replaced in the order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Updates an order

> Updates the order with the specified ID

```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":{"GetOrderOrderUpdate":{"$ref":"#/components/schemas/Order"},"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"]},"GetOrder":{"$ref":"#/components/schemas/Order"}},"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/v1/channel/{channel_id}/update_order/{id}/":{"put":{"tags":["SalesChannelOrders"],"summary":"Updates an order","description":"Updates the order with the specified ID","operationId":"update_order","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderOrderUpdate"}}}},"responses":{"200":{"description":"Order successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrder"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Partial update of an order

> Partially updates the order with the specified ID

```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":{"GetOrderOrderUpdate":{"$ref":"#/components/schemas/Order"},"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"]},"GetOrder":{"$ref":"#/components/schemas/Order"}},"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/v1/channel/{channel_id}/update_order/{id}/":{"patch":{"tags":["SalesChannelOrders"],"summary":"Partial update of an order","description":"Partially updates the order with the specified ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderOrderUpdate"}}}},"responses":{"200":{"description":"Order successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrder"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Update cancel status of an order

> Update the cancel status of the order with the specified ID

```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":{"GetOrderCancelStatusUpdate":{"$ref":"#/components/schemas/OrderCancelStatusUpdate"},"OrderCancelStatusUpdate":{"type":"object","properties":{"order":{"type":"integer","description":"ID of the order to be updated."},"order_items":{"type":"array","description":"List of order item IDs to be updated.","items":{"type":"integer","description":"List of order item IDs to be updated."}},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/update_cancel_status/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Update cancel status of an order","description":"Update the cancel status of the order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderCancelStatusUpdate"}}}},"responses":{"200":{"description":"Order cancel status successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Get remote ID of an order

> Retrieve the remote ID of an order with the specified ID

```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":{"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/v1/channel/{channel_id}/orders/{id}/get_remote_id/":{"get":{"tags":["SalesChannelOrders"],"summary":"Get remote ID of an order","description":"Retrieve the remote ID of an order with the specified ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Remote ID found successfully","content":{"application/json":{"schema":{"type":"object","properties":{"order_id":{"type":"integer"},"remote_id":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Order find by ID

> Retrieve order by ID

```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":{"GetOrder":{"$ref":"#/components/schemas/Order"},"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"]}},"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/v1/channel/{channel_id}/orders/{id}/":{"get":{"tags":["SalesChannelOrders"],"summary":"Order find by ID","description":"Retrieve order by ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Order found successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrder"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Order find by ID

> Retrieve order detailed by ID

```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":{"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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/v1/channel/{channel_id}/orders/{id}/detailed/":{"get":{"tags":["SalesChannelOrders"],"summary":"Order find by ID","description":"Retrieve order detailed by ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Order found successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Get order gateway pos history

> Retrieve the gateway pos history for the order with the specified ID

```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":{"OrderGatewayPosHistory":{"type":"object","description":"Gateway POS history","properties":{"gateway_pos_history":{"type":"object","description":"Gateway POS history details","properties":{"is_success":{"type":"boolean","description":"Indicates if the operation was successful"},"message":{"type":"string","description":"Message related to the operation"},"gateway":{"type":"string","description":"Gateway used for the operation"},"history":{"type":"string","description":"History of the operation"}}}}}},"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/v1/channel/{channel_id}/orders/{id}/gateway_pos_history/":{"get":{"tags":["SalesChannelOrders"],"summary":"Get order gateway pos history","description":"Retrieve the gateway pos history for the order with the specified ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Gateway pos history found successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderGatewayPosHistory"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Capture order

> Capture order with given id

```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":{"GetCaptureOrder":{"$ref":"#/components/schemas/CaptureOrder"},"CaptureOrder":{"properties":{"force_refund":{"type":"boolean"}}}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/capture_order/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Capture order","description":"Capture order with given id","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCaptureOrder"}}}},"responses":{"200":{"description":"Order capture done successfully","content":{"application/json":{"schema":{"type":"object","description":"An empty dictionary"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Accept an order in retail store

> Accept when staff took the order in retail store. Update order item statuses to ready\_for\_pickup.

```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":{"GetOrder":{"$ref":"#/components/schemas/Order"},"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"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/accept_in_store/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Accept an order in retail store","description":"Accept when staff took the order in retail store. Update order item statuses to ready_for_pickup.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"An empty dictionary"}}}},"responses":{"200":{"description":"Order successfully accepted in store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrder"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## POST /api/v1/channel/{channel\_id}/orders/{id}/bulk\_tracking\_number\_update/

> Bulk update tracking number status

```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."}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/bulk_tracking_number_update/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Bulk update tracking number status","requestBody":{"required":true,"content":{"form-data":{"schema":{"type":"object","properties":{"filename":{"type":"string","format":"binary","description":"The file containing the tracking numbers to be updated."}}}}}},"responses":{"200":{"description":"Tracking number status successfully updated","content":{"application/json":{"schema":{"type":"object","properties":{"cache":{"type":"string","format":"uuid","description":"The cache ID for the tracking number update operation."}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Change order status

> Change the status of the order with the specified ID

```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":{"GetOrderChangeStatus":{"$ref":"#/components/schemas/OrderStatusChange"},"OrderStatusChange":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/OrderStatus"}}},"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"}},"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."}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/change_order_status/":{"patch":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Change order status","description":"Change the status of the order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderChangeStatus"}}}},"responses":{"200":{"description":"Order status successfully updated"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Change order shipping address

> Change the shipping address of the order with the specified ID

```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":{"GetOrderChangeShippingAddress":{"$ref":"#/components/schemas/OrderShippingAddress"},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]}},"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."}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/change_shipping_address/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Change order shipping address","description":"Change the shipping address of the order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderChangeShippingAddress"}}}},"responses":{"200":{"description":"Order shipping address successfully updated"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Bulk replace products and reduce weights in an order

> Replace multiple products and reduce their weights in an order with the specified ID

```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":{"GetOrderBulkReplaceProductAndReduceWeight":{"$ref":"#/components/schemas/BulkReplaceProductAndReduceWeight"},"BulkReplaceProductAndReduceWeight":{"type":"array","description":"List of order items for product replacement and weight reduction","items":{"$ref":"#/components/schemas/BulkReplaceProductAndReduceWeightItem"}},"BulkReplaceProductAndReduceWeightItem":{"properties":{"order_item":{"type":"integer","description":"Order item ID for product replacement and weight reduction"},"new_product_sku":{"type":"string","description":"New product SKU for replacement"},"new_weight":{"type":"number","format":"decimal","description":"New weight for the order item"}}},"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/bulk_replace_product_and_reduce_weight/":{"post":{"tags":["SalesChannelOrders"],"summary":"Bulk replace products and reduce weights in an order","description":"Replace multiple products and reduce their weights in an order with the specified ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderBulkReplaceProductAndReduceWeight"}}}},"responses":{"200":{"description":"Products successfully replaced and weights reduced in the order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Cancel an order

> Approve cancellation of an order with the specified ID

```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":{"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/cancellation_approved_order/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Cancel an order","description":"Approve cancellation of an order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"An empty dictionary"}}}},"responses":{"200":{"description":"Order successfully cancelled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Order find by ID

> Retrieve order by ID

```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"}},"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}}},"schemas":{"OrderDataSource":{"type":"object","properties":{"pk":{"type":"integer","description":"The unique identifier for the data source."},"name":{"type":"string","maxLength":64,"description":"The name of the data source."}}}},"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/v1/channel/{channel_id}/orders/{id}/data_sources/":{"get":{"tags":["SalesChannelOrders"],"summary":"Order find by ID","description":"Retrieve order by ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"}],"responses":{"200":{"description":"Order found successfully","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","description":"Next page URL","nullable":true},"previous":{"type":"string","description":"Previous page URL","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/OrderDataSource"}}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## List orders

> Retrieve a list of orders with optional filtering

```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"}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"pk__in":{"name":"pk__in","in":"query","description":"Filter by multiple primary key values (comma-separated list of integers)","required":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":false},"mapping":{"name":"mapping","in":"query","required":false,"description":"Filters by mapping id","schema":{"type":"integer"}},"status_filter":{"name":"status","in":"query","description":"Filter by order item status","schema":{"$ref":"#/components/schemas/OrderStatus"}},"is_send":{"name":"is_send","in":"query","description":"Filter by is_send boolean field","required":false,"schema":{"type":"boolean"}},"shipping_company":{"name":"shipping_company","in":"query","description":"Filter by shipping company.","schema":{"$ref":"#/components/schemas/ShippingCompany"}},"cancel_status":{"name":"cancel_status","in":"query","description":"Filter by cancel status","required":false,"schema":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]}},"invoice_number_filter":{"name":"invoice_number","in":"query","description":"Filter by invoice number","schema":{"type":"string"}},"invoice_number__isnull":{"name":"invoice_number__isnull","in":"query","description":"Filter by whether the invoice number is null","schema":{"type":"boolean"}},"customer":{"name":"customer_id","in":"query","description":"Filter by customer ID.","required":false,"schema":{"type":"integer"}},"currency_filter":{"name":"currency","in":"query","description":"Filter by currency type.","schema":{"$ref":"#/components/schemas/CurrencyEnum"}},"has_gift_box":{"name":"has_gift_box","in":"query","description":"Filter by whether the order has a gift box","schema":{"type":"boolean"}},"has_gift_note":{"name":"has_gift_note","in":"query","description":"Filter by whether the order has a gift note","schema":{"type":"boolean"}},"extra_field":{"name":"extra_field","in":"query","description":"Filter by extra field attributes","schema":{"type":"object","additionalProperties":true}},"e_archive_url__isnull":{"name":"e_archive_url__isnull","in":"query","description":"Filter by whether the e-archive URL is null","schema":{"type":"boolean"}},"date_placed":{"name":"date_placed","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Order number (case-insensitive)"},"date_placed__gte":{"name":"date_placed__gte","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"date_placed__gt":{"name":"date_placed__gt","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Order placed after this date"},"date_placed__lt":{"name":"date_placed__lt","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"date_placed__lte":{"name":"date_placed__lte","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"date_placed__date__gt":{"name":"date_placed__date__gt","in":"query","required":false,"schema":{"type":"string","format":"date"}},"date_placed__date__gte":{"name":"date_placed__date__gte","in":"query","required":false,"schema":{"type":"string","format":"date"}},"date_placed__date__lt":{"name":"date_placed__date__lt","in":"query","required":false,"schema":{"type":"string","format":"date"}},"date_placed__date__lte":{"name":"date_placed__date__lte","in":"query","required":false,"schema":{"type":"string","format":"date"}},"cargo_company__name":{"name":"cargo_company__name","in":"query","description":"Filter by cargo company name","schema":{"type":"string"}},"payment_option":{"name":"payment_option","in":"query","description":"Filter by payment option IDs","schema":{"type":"array","items":{"type":"integer"}}},"fund_transfer_payment_bank":{"name":"fund_transfer_payment_bank","in":"query","description":"Filter by fund transfer payment bank IDs","schema":{"type":"array","items":{"type":"integer"}}},"delivery_option":{"name":"delivery_option","in":"query","description":"Filter by delivery option IDs","schema":{"type":"array","items":{"type":"integer"}}},"sku":{"name":"sku","in":"query","required":false,"schema":{"type":"string"},"description":"Product SKU (case-insensitive)"},"base_code":{"name":"base_code","in":"query","description":"Filter by base code.","required":false,"schema":{"type":"string"}},"amount":{"name":"amount","in":"query","required":false,"description":"Filter by amount.","schema":{"type":"number","format":"decimal"}},"discount_amount":{"name":"discount_amount","in":"query","description":"Filter by discount amount","schema":{"type":"number","format":"decimal"}},"pos":{"name":"pos","in":"query","description":"Filter by point of sale name","schema":{"type":"string"}},"external_status":{"name":"external_status","in":"query","description":"Filter by order external status ID","schema":{"type":"integer"}},"number__exact":{"name":"number__exact","in":"query","description":"Filter by exact order number","schema":{"type":"string"}},"client_type":{"name":"client_type","in":"query","description":"Filter by client type","schema":{"$ref":"#/components/schemas/ClientType"}},"cancellation_plan_status":{"name":"cancellation_plan_status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanStatus"},"description":"Status of related cancellation plan"},"shipping_amount":{"name":"shipping_amount","in":"query","description":"Filter by shipping amount","schema":{"type":"number","format":"decimal"}},"shipping_amount__gt":{"name":"shipping_amount__gt","in":"query","description":"Filter by shipping amount greater than a value","schema":{"type":"number","format":"decimal"}},"shipping_amount__gte":{"name":"shipping_amount__gte","in":"query","description":"Filter by shipping amount greater than or equal to a value","schema":{"type":"number","format":"decimal"}},"shipping_amount__lt":{"name":"shipping_amount__lt","in":"query","description":"Filter by shipping amount less than a value","schema":{"type":"number","format":"decimal"}},"shipping_amount__lte":{"name":"shipping_amount__lte","in":"query","description":"Filter by shipping amount less than or equal to a value","schema":{"type":"number","format":"decimal"}},"number":{"name":"number","in":"query","required":false,"schema":{"type":"string"},"description":"Order number (case-insensitive)"},"tracking_number":{"name":"tracking_number","in":"query","required":false,"schema":{"type":"string"},"description":"Tracking number (case-insensitive)"},"coupon_code":{"name":"coupon_code","in":"query","description":"Filter by coupon code","schema":{"type":"string"}},"data_source":{"name":"data_source","in":"query","description":"Filter by data source IDs.","schema":{"type":"array","items":{"type":"integer"}}},"vendororder__isnull":{"name":"vendororder__isnull","in":"query","description":"Filter by whether the vendor order is null","schema":{"type":"boolean"}},"brand__exact":{"name":"brand__exact","in":"query","description":"Filter by exact brand name","schema":{"type":"string"}},"succeeded_transaction_or_payment_option":{"name":"succeeded_transaction_or_payment_option","in":"query","description":"Filter by succeeded transaction or payment option ID","schema":{"type":"array","items":{"type":"integer"}}},"waiting_capture":{"name":"waiting_capture","in":"query","description":"Filter by whether the order is waiting for capture","schema":{"type":"boolean"}},"checkout_provider_id__in":{"name":"checkout_provider_id__in","in":"query","description":"Filter by checkout provider IDs","schema":{"type":"array","items":{"type":"integer"}}},"erp_code":{"name":"erp_code","in":"query","description":"Filter by ERP code (contains)","required":false,"schema":{"type":"string"}}},"schemas":{"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"},"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"]},"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"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"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"]},"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"}}}},"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/v1/channel/{channel_id}/orders/":{"get":{"tags":["SalesChannelOrders"],"summary":"List orders","description":"Retrieve a list of orders with optional filtering","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/pk__in"},{"$ref":"#/components/parameters/mapping"},{"$ref":"#/components/parameters/status_filter"},{"$ref":"#/components/parameters/is_send"},{"$ref":"#/components/parameters/shipping_company"},{"$ref":"#/components/parameters/cancel_status"},{"$ref":"#/components/parameters/invoice_number_filter"},{"$ref":"#/components/parameters/invoice_number__isnull"},{"$ref":"#/components/parameters/customer"},{"$ref":"#/components/parameters/currency_filter"},{"$ref":"#/components/parameters/has_gift_box"},{"$ref":"#/components/parameters/has_gift_note"},{"$ref":"#/components/parameters/extra_field"},{"$ref":"#/components/parameters/e_archive_url__isnull"},{"$ref":"#/components/parameters/date_placed"},{"$ref":"#/components/parameters/date_placed__gte"},{"$ref":"#/components/parameters/date_placed__gt"},{"$ref":"#/components/parameters/date_placed__lt"},{"$ref":"#/components/parameters/date_placed__lte"},{"$ref":"#/components/parameters/date_placed__date__gt"},{"$ref":"#/components/parameters/date_placed__date__gte"},{"$ref":"#/components/parameters/date_placed__date__lt"},{"$ref":"#/components/parameters/date_placed__date__lte"},{"$ref":"#/components/parameters/cargo_company__name"},{"$ref":"#/components/parameters/payment_option"},{"$ref":"#/components/parameters/fund_transfer_payment_bank"},{"$ref":"#/components/parameters/delivery_option"},{"$ref":"#/components/parameters/sku"},{"$ref":"#/components/parameters/base_code"},{"$ref":"#/components/parameters/amount"},{"$ref":"#/components/parameters/discount_amount"},{"$ref":"#/components/parameters/pos"},{"$ref":"#/components/parameters/external_status"},{"$ref":"#/components/parameters/number__exact"},{"$ref":"#/components/parameters/client_type"},{"$ref":"#/components/parameters/cancellation_plan_status"},{"$ref":"#/components/parameters/shipping_amount"},{"$ref":"#/components/parameters/shipping_amount__gt"},{"$ref":"#/components/parameters/shipping_amount__gte"},{"$ref":"#/components/parameters/shipping_amount__lt"},{"$ref":"#/components/parameters/shipping_amount__lte"},{"$ref":"#/components/parameters/number"},{"$ref":"#/components/parameters/tracking_number"},{"$ref":"#/components/parameters/coupon_code"},{"$ref":"#/components/parameters/data_source"},{"$ref":"#/components/parameters/vendororder__isnull"},{"$ref":"#/components/parameters/brand__exact"},{"$ref":"#/components/parameters/succeeded_transaction_or_payment_option"},{"$ref":"#/components/parameters/waiting_capture"},{"$ref":"#/components/parameters/checkout_provider_id__in"},{"$ref":"#/components/parameters/erp_code"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","description":"Next page URL","nullable":true},"previous":{"type":"string","description":"Previous page URL","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Create a new order

> Creates a new order in the system for the specified 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"}}},"schemas":{"GetOrderOrderCreate":{"$ref":"#/components/schemas/Order"},"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"]},"GetOrder":{"$ref":"#/components/schemas/Order"}},"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."}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"}],"summary":"Create a new order","description":"Creates a new order in the system for the specified channel","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderOrderCreate"}}}},"responses":{"201":{"description":"Order created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrder"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## List orders with details

> Retrieve a list of orders with optional filtering and detailed information

```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"}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"pk__in":{"name":"pk__in","in":"query","description":"Filter by multiple primary key values (comma-separated list of integers)","required":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":false},"mapping":{"name":"mapping","in":"query","required":false,"description":"Filters by mapping id","schema":{"type":"integer"}},"status_filter":{"name":"status","in":"query","description":"Filter by order item status","schema":{"$ref":"#/components/schemas/OrderStatus"}},"is_send":{"name":"is_send","in":"query","description":"Filter by is_send boolean field","required":false,"schema":{"type":"boolean"}},"shipping_company":{"name":"shipping_company","in":"query","description":"Filter by shipping company.","schema":{"$ref":"#/components/schemas/ShippingCompany"}},"cancel_status":{"name":"cancel_status","in":"query","description":"Filter by cancel status","required":false,"schema":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]}},"invoice_number_filter":{"name":"invoice_number","in":"query","description":"Filter by invoice number","schema":{"type":"string"}},"invoice_number__isnull":{"name":"invoice_number__isnull","in":"query","description":"Filter by whether the invoice number is null","schema":{"type":"boolean"}},"customer":{"name":"customer_id","in":"query","description":"Filter by customer ID.","required":false,"schema":{"type":"integer"}},"currency_filter":{"name":"currency","in":"query","description":"Filter by currency type.","schema":{"$ref":"#/components/schemas/CurrencyEnum"}},"has_gift_box":{"name":"has_gift_box","in":"query","description":"Filter by whether the order has a gift box","schema":{"type":"boolean"}},"has_gift_note":{"name":"has_gift_note","in":"query","description":"Filter by whether the order has a gift note","schema":{"type":"boolean"}},"extra_field":{"name":"extra_field","in":"query","description":"Filter by extra field attributes","schema":{"type":"object","additionalProperties":true}},"e_archive_url__isnull":{"name":"e_archive_url__isnull","in":"query","description":"Filter by whether the e-archive URL is null","schema":{"type":"boolean"}},"date_placed":{"name":"date_placed","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Order number (case-insensitive)"},"date_placed__gte":{"name":"date_placed__gte","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"date_placed__gt":{"name":"date_placed__gt","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Order placed after this date"},"date_placed__lt":{"name":"date_placed__lt","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"date_placed__lte":{"name":"date_placed__lte","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},"date_placed__date__gt":{"name":"date_placed__date__gt","in":"query","required":false,"schema":{"type":"string","format":"date"}},"date_placed__date__gte":{"name":"date_placed__date__gte","in":"query","required":false,"schema":{"type":"string","format":"date"}},"date_placed__date__lt":{"name":"date_placed__date__lt","in":"query","required":false,"schema":{"type":"string","format":"date"}},"date_placed__date__lte":{"name":"date_placed__date__lte","in":"query","required":false,"schema":{"type":"string","format":"date"}},"cargo_company__name":{"name":"cargo_company__name","in":"query","description":"Filter by cargo company name","schema":{"type":"string"}},"payment_option":{"name":"payment_option","in":"query","description":"Filter by payment option IDs","schema":{"type":"array","items":{"type":"integer"}}},"fund_transfer_payment_bank":{"name":"fund_transfer_payment_bank","in":"query","description":"Filter by fund transfer payment bank IDs","schema":{"type":"array","items":{"type":"integer"}}},"delivery_option":{"name":"delivery_option","in":"query","description":"Filter by delivery option IDs","schema":{"type":"array","items":{"type":"integer"}}},"sku":{"name":"sku","in":"query","required":false,"schema":{"type":"string"},"description":"Product SKU (case-insensitive)"},"base_code":{"name":"base_code","in":"query","description":"Filter by base code.","required":false,"schema":{"type":"string"}},"amount":{"name":"amount","in":"query","required":false,"description":"Filter by amount.","schema":{"type":"number","format":"decimal"}},"discount_amount":{"name":"discount_amount","in":"query","description":"Filter by discount amount","schema":{"type":"number","format":"decimal"}},"pos":{"name":"pos","in":"query","description":"Filter by point of sale name","schema":{"type":"string"}},"external_status":{"name":"external_status","in":"query","description":"Filter by order external status ID","schema":{"type":"integer"}},"number__exact":{"name":"number__exact","in":"query","description":"Filter by exact order number","schema":{"type":"string"}},"client_type":{"name":"client_type","in":"query","description":"Filter by client type","schema":{"$ref":"#/components/schemas/ClientType"}},"cancellation_plan_status":{"name":"cancellation_plan_status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CancellationPlanStatus"},"description":"Status of related cancellation plan"},"shipping_amount":{"name":"shipping_amount","in":"query","description":"Filter by shipping amount","schema":{"type":"number","format":"decimal"}},"shipping_amount__gt":{"name":"shipping_amount__gt","in":"query","description":"Filter by shipping amount greater than a value","schema":{"type":"number","format":"decimal"}},"shipping_amount__gte":{"name":"shipping_amount__gte","in":"query","description":"Filter by shipping amount greater than or equal to a value","schema":{"type":"number","format":"decimal"}},"shipping_amount__lt":{"name":"shipping_amount__lt","in":"query","description":"Filter by shipping amount less than a value","schema":{"type":"number","format":"decimal"}},"shipping_amount__lte":{"name":"shipping_amount__lte","in":"query","description":"Filter by shipping amount less than or equal to a value","schema":{"type":"number","format":"decimal"}},"number":{"name":"number","in":"query","required":false,"schema":{"type":"string"},"description":"Order number (case-insensitive)"},"tracking_number":{"name":"tracking_number","in":"query","required":false,"schema":{"type":"string"},"description":"Tracking number (case-insensitive)"},"coupon_code":{"name":"coupon_code","in":"query","description":"Filter by coupon code","schema":{"type":"string"}},"data_source":{"name":"data_source","in":"query","description":"Filter by data source IDs.","schema":{"type":"array","items":{"type":"integer"}}},"vendororder__isnull":{"name":"vendororder__isnull","in":"query","description":"Filter by whether the vendor order is null","schema":{"type":"boolean"}},"brand__exact":{"name":"brand__exact","in":"query","description":"Filter by exact brand name","schema":{"type":"string"}},"succeeded_transaction_or_payment_option":{"name":"succeeded_transaction_or_payment_option","in":"query","description":"Filter by succeeded transaction or payment option ID","schema":{"type":"array","items":{"type":"integer"}}},"waiting_capture":{"name":"waiting_capture","in":"query","description":"Filter by whether the order is waiting for capture","schema":{"type":"boolean"}},"checkout_provider_id__in":{"name":"checkout_provider_id__in","in":"query","description":"Filter by checkout provider IDs","schema":{"type":"array","items":{"type":"integer"}}},"erp_code":{"name":"erp_code","in":"query","description":"Filter by ERP code (contains)","required":false,"schema":{"type":"string"}}},"schemas":{"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"},"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"]},"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"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"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"]},"GetOrderDetailedList":{"$ref":"#/components/schemas/OrderDetailedList"},"OrderDetailedList":{"type":"array","items":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","description":"Tax rate applied to the shipping charge."},"extra_field":{"type":"object","description":"Additional information about the order."},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","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","description":"Message for the gift box."},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"include_unified_order":{"type":"boolean","description":"Indicates whether the order is unified."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"segment":{"type":"string","description":"Customer segment for the order."},"vendororder_set":{"type":"array","items":{"$ref":"#/components/schemas/VendorOrderWithDataSource"}},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"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"]},"VendorOrderWithDataSource":{"type":"object","properties":{"data_source":{"$ref":"#/components/schemas/DataSource"}}},"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"]}},"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/v1/channel/{channel_id}/orders/detailed/":{"get":{"tags":["SalesChannelOrders"],"summary":"List orders with details","description":"Retrieve a list of orders with optional filtering and detailed information","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/pk__in"},{"$ref":"#/components/parameters/mapping"},{"$ref":"#/components/parameters/status_filter"},{"$ref":"#/components/parameters/is_send"},{"$ref":"#/components/parameters/shipping_company"},{"$ref":"#/components/parameters/cancel_status"},{"$ref":"#/components/parameters/invoice_number_filter"},{"$ref":"#/components/parameters/invoice_number__isnull"},{"$ref":"#/components/parameters/customer"},{"$ref":"#/components/parameters/currency_filter"},{"$ref":"#/components/parameters/has_gift_box"},{"$ref":"#/components/parameters/has_gift_note"},{"$ref":"#/components/parameters/extra_field"},{"$ref":"#/components/parameters/e_archive_url__isnull"},{"$ref":"#/components/parameters/date_placed"},{"$ref":"#/components/parameters/date_placed__gte"},{"$ref":"#/components/parameters/date_placed__gt"},{"$ref":"#/components/parameters/date_placed__lt"},{"$ref":"#/components/parameters/date_placed__lte"},{"$ref":"#/components/parameters/date_placed__date__gt"},{"$ref":"#/components/parameters/date_placed__date__gte"},{"$ref":"#/components/parameters/date_placed__date__lt"},{"$ref":"#/components/parameters/date_placed__date__lte"},{"$ref":"#/components/parameters/cargo_company__name"},{"$ref":"#/components/parameters/payment_option"},{"$ref":"#/components/parameters/fund_transfer_payment_bank"},{"$ref":"#/components/parameters/delivery_option"},{"$ref":"#/components/parameters/sku"},{"$ref":"#/components/parameters/base_code"},{"$ref":"#/components/parameters/amount"},{"$ref":"#/components/parameters/discount_amount"},{"$ref":"#/components/parameters/pos"},{"$ref":"#/components/parameters/external_status"},{"$ref":"#/components/parameters/number__exact"},{"$ref":"#/components/parameters/client_type"},{"$ref":"#/components/parameters/cancellation_plan_status"},{"$ref":"#/components/parameters/shipping_amount"},{"$ref":"#/components/parameters/shipping_amount__gt"},{"$ref":"#/components/parameters/shipping_amount__gte"},{"$ref":"#/components/parameters/shipping_amount__lt"},{"$ref":"#/components/parameters/shipping_amount__lte"},{"$ref":"#/components/parameters/number"},{"$ref":"#/components/parameters/tracking_number"},{"$ref":"#/components/parameters/coupon_code"},{"$ref":"#/components/parameters/data_source"},{"$ref":"#/components/parameters/vendororder__isnull"},{"$ref":"#/components/parameters/brand__exact"},{"$ref":"#/components/parameters/succeeded_transaction_or_payment_option"},{"$ref":"#/components/parameters/waiting_capture"},{"$ref":"#/components/parameters/checkout_provider_id__in"},{"$ref":"#/components/parameters/erp_code"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailedList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Create mapping object for the order

> Create a mapping object for the order with the specified ID

```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":{"GetOrderCreateMapping":{"$ref":"#/components/schemas/OrderCreateMapping"},"OrderCreateMapping":{"type":"object","properties":{"code":{"type":"string","description":"Unique code for the mapping."},"integration_type":{"$ref":"#/components/schemas/IntegrationMappingType"},"content_type":{"type":"integer","description":"Content type of the mapping."},"object_id":{"type":"integer","description":"ID of the object associated with the mapping."}}},"IntegrationMappingType":{"type":"string","description":"Type of integration mapping","enum":["hepsiburada","hepsiburadads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"GetOrderCreateMappingResponse":{"$ref":"#/components/schemas/OrderCreateMappingResponse"},"OrderCreateMappingResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/OrderCreateMapping"},{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier for the mapping."}}},"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."}}}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/create_mapping/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Create mapping object for the order","description":"Create a mapping object for the order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderCreateMapping"}}}},"responses":{"200":{"description":"Order mapping object successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderCreateMappingResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Change order billing address

> Change the billing address of the order with the specified ID

```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":{"GetOrderChangeBillingAddress":{"$ref":"#/components/schemas/OrderBillingAddress"},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]}},"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."}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/change_billing_address/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Change order billing address","description":"Change the billing address of the order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderChangeBillingAddress"}}}},"responses":{"200":{"description":"Order billing address successfully updated"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Refund an order

> Refund an order with the specified ID

```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":{"GetOrderRefund":{"$ref":"#/components/schemas/OrderRefund"},"OrderRefund":{"type":"object","properties":{"is_refund_success":{"type":"boolean","description":"Indicates whether the refund was successful."}},"required":["is_refund_success"]},"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/refund/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Refund an order","description":"Refund an order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderRefund"}}}},"responses":{"200":{"description":"Order successfully refunded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Deliver an order in retail store to the customer

> Deliver when staff deliver the order to the customer in retail store. Update order item statuses to delivered.

```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":{"GetOrder":{"$ref":"#/components/schemas/Order"},"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"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/deliver_in_store/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Deliver an order in retail store to the customer","description":"Deliver when staff deliver the order to the customer in retail store. Update order item statuses to delivered.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"An empty dictionary"}}}},"responses":{"200":{"description":"Order delivered in store successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrder"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Status of the bulk update tracking number action

> Status of the bulk update tracking number specified with cache key

```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":{"BulkProcessStatusResponse":{"type":"object","properties":{"progress":{"type":"array"},"errors":{"type":"array"},"chunk_count":{"type":"integer"},"status":{"$ref":"#/components/schemas/BulkProcessStatusEnum"}}},"BulkProcessStatusEnum":{"type":"string","description":"Status of the bulk process","enum":["waiting","in_progress","completed"]}},"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/v1/channel/{channel_id}/orders/{id}/bulk_tracking_number_update_status/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Status of the bulk update tracking number action","description":"Status of the bulk update tracking number specified with cache key","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cache":{"type":"string","format":"uuid","description":"The cache ID for the tracking number update operation."}}}}}},"responses":{"200":{"description":"Tracking number status successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkProcessStatusResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}}}}
```

## Mark order as not sent

> Mark the order with the specified ID as not sent

```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":{"GetOrder":{"$ref":"#/components/schemas/Order"},"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"]}},"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/v1/channel/{channel_id}/orders/{id}/mark_as_not_sent/":{"post":{"tags":["SalesChannelOrders"],"summary":"Mark order as not sent","description":"Mark the order with the specified ID as not sent","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"An empty dictionary"}}}},"responses":{"200":{"description":"Order successfully marked as not sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrder"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Update order status

> Update order status of the order with the specified ID

```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":{"GetOrderDetailedList":{"$ref":"#/components/schemas/OrderDetailedList"},"OrderDetailedList":{"type":"array","items":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","description":"Tax rate applied to the shipping charge."},"extra_field":{"type":"object","description":"Additional information about the order."},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","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","description":"Message for the gift box."},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"include_unified_order":{"type":"boolean","description":"Indicates whether the order is unified."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"segment":{"type":"string","description":"Customer segment for the order."},"vendororder_set":{"type":"array","items":{"$ref":"#/components/schemas/VendorOrderWithDataSource"}},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"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"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"VendorOrderWithDataSource":{"type":"object","properties":{"data_source":{"$ref":"#/components/schemas/DataSource"}}},"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"]}},"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/v1/channel/{channel_id}/orders/{id}/update_order_status/":{"get":{"tags":["SalesChannelOrders"],"summary":"Update order status","description":"Update order status of the order with the specified ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Order status successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailedList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}}}}
```

## Cancel an order

> Cancel an order with the specified ID

```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":{"GetOrderCancelOrder":{"$ref":"#/components/schemas/OrderCancel"},"OrderCancel":{"type":"object","properties":{"order":{"type":"integer","description":"ID of the order to be cancelled."},"is_all":{"type":"boolean","description":"Indicates whether to cancel all items in the order."},"cancel_items":{"type":"array","description":"List of order item IDs to be cancelled.","items":{"type":"integer","description":"List of order item IDs to be cancelled."}},"forced_refund_amount":{"type":"number","format":"decimal","description":"Amount to be refunded."},"reasons":{"type":"object","description":"Cancellation reasons for each order item."},"is_cargo_refund":{"type":"boolean","description":"Indicates whether to refund the shipping amount."},"refund_invoice_number":{"type":"string","description":"Invoice number for the refund."},"holder_names":{"type":"object","description":"Holder names for the cancel items."},"fully_refund_as_loyalty_money":{"type":"boolean","description":"Indicates whether to fully refund as loyalty money."}}},"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/cancel/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Cancel an order","description":"Cancel an order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderCancelOrder"}}}},"responses":{"200":{"description":"Order successfully cancelled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Split packages of an order

> Split the packages of the order with the specified ID

```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":{"GetOrderSplitPackages":{"$ref":"#/components/schemas/OrderSplitPackages"},"OrderSplitPackages":{"type":"object","properties":{"payload":{"type":"object","description":"Payload containing the split packages.","items":{"$ref":"#/components/schemas/OrderSplit"}}}},"OrderSplit":{"type":"object","properties":{"number":{"type":"string","description":"Order number, unique within the context of a channel."},"packages":{"type":"object","description":"Packages associated with the order."}}}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/split_packages/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Split packages of an order","description":"Split the packages of the order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderSplitPackages"}}}},"responses":{"200":{"description":"Order packages successfully split","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Bulk reduce weights in an order

> Reduce the weights of multiple products in an order with the specified ID

```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":{"GetOrderBulkReduceWeight":{"$ref":"#/components/schemas/BulkReduceWeight"},"BulkReduceWeight":{"type":"array","description":"List of order items for weight reduction","items":{"$ref":"#/components/schemas/BulkReduceWeightItem"}},"BulkReduceWeightItem":{"properties":{"order_item":{"type":"integer","description":"Order item ID for weight reduction"},"new_weight":{"type":"number","format":"decimal","description":"New weight for the order item"}}},"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/bulk_reduce_weights/":{"post":{"tags":["SalesChannelOrders"],"summary":"Bulk reduce weights in an order","description":"Reduce the weights of multiple products in an order with the specified ID","parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderBulkReduceWeight"}}}},"responses":{"200":{"description":"Weights successfully reduced in the order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```

## Cancel an order

> Reject a cancellation of an order with the specified ID

```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":{"GetOrderDetailed":{"$ref":"#/components/schemas/OrderDetailed"},"OrderDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"$ref":"#/components/schemas/Channel"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/OrderShippingAddress"},"billing_address":{"$ref":"#/components/schemas/OrderBillingAddress"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"extra_field":{"type":"object","description":"Additional information about the order."},"orderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"discountitem_set":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItem"}},"transaction_set":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDetailed"}},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"payment_option_slug":{"type":"string","description":"Slug of the payment option."},"bin_number":{"type":"string","description":"First 6 digits of the customer's card used in the transaction."},"installment":{"$ref":"#/components/schemas/Installment"},"installment_count":{"type":"integer","description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"$ref":"#/components/schemas/CargoCompany"},"invoice_number":{"type":"string","description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","description":"URL for the e-archive of the invoice."},"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."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"status_display":{"type":"string","description":"Display name of the order status."},"tracking_number":{"type":"string","description":"Tracking number for the order."},"is_send":{"type":"boolean","description":"Indicates whether the order recorded to erp."},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount for the order."},"remote_addr":{"type":"string","format":"ipv4","description":"IP address from where the order was placed."},"language_code":{"type":"string","description":"Language code for the order."},"fundstransfertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/FundsTransferTransactionReadOnly"}},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","description":"Message for the gift box."},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item"},"external_status":{"$ref":"#/components/schemas/OrderExternalStatus"},"payondeliverytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/PayOnDeliveryTransaction"}},"loyaltytransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyTransaction"}},"bextransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/BexTransactionDetailed"}},"b2btransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/B2BTransaction"}},"cancellationplan_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlan"}},"cashregistertransaction_set":{"type":"array","items":{"$ref":"#/components/schemas/CashRegisterTransaction"}},"client_type":{"$ref":"#/components/schemas/ClientType"},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"delivery_type":{"$ref":"#/components/schemas/ShippingOptionDeliveryType"},"notes":{"type":"string","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","description":"Slug for the shipping option."},"segment":{"type":"string","description":"Customer segment for the order."},"carrier_shipping_code":{"type":"string","description":"Tracking code assigned by the carrier."},"defined_tracking_url":{"type":"string","format":"url","description":"URL for tracking the order."},"installment_free":{"type":"boolean","description":"Indicates whether the order is installment-free."}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"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"},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]},"OrderShippingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"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."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"OrderBillingAddress":{"$ref":"#/components/schemas/AddressDetailed"},"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"]},"OrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"type":"integer","description":"Related order ID"},"product":{"type":"integer","description":"Related product ID"},"price_list":{"type":"integer","description":"Related price list ID"},"stock_list":{"type":"integer","description":"Related stock list ID"},"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},"datasource":{"type":"integer","description":"Related data source ID","nullable":true},"cancellation_reconciliation":{"type":"integer","description":"Related cancellation reconciliation ID","nullable":true},"reconciliation":{"type":"integer","description":"Related reconciliation ID","nullable":true},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"original_stock":{"type":"integer","description":"Original stock ID","nullable":true},"shipping_option_group":{"type":"integer","description":"Related shipping option group ID","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}},"required":["pk","order","product","status","price_currency","price","tax_rate"]},"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."}}},"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"]},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"DiscountItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the discount item"},"name":{"type":"string","description":"Name of the discount item"},"amount":{"type":"number","format":"decimal","description":"Amount of the discount item"},"order":{"type":"integer","description":"ID of the related order"},"offer_type":{"$ref":"#/components/schemas/OfferType"},"session_offer_type":{"$ref":"#/components/schemas/SessionOfferType"},"code":{"type":"string","description":"Code of the discount item"},"promotion":{"type":"integer","description":"ID of the related promotion"},"cancel_amount":{"type":"number","format":"decimal","description":"Amount to be canceled"},"data_source_discount_sharing_rate":{"type":"number","format":"decimal","description":"Discount sharing rate for data source"}}},"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]},"SessionOfferType":{"type":"string","description":"Type of session offer","enum":["ayakkabidunyasi","sephora","zubizu","adunyasi_loyalty_card","default_loyalty_card","giz_eticaret_promotion_v2","obase","obase_promotion_gateway","loccitane","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension"]},"TransactionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"auth_code":{"type":"string","description":"Authorization code for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"main_pos":{"$ref":"#/components/schemas/Pos"},"order":{"$ref":"#/components/schemas/Order"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"is_async_payment":{"type":"boolean","description":"Indicates if the payment was asynchronous"},"transaction_response_status":{"$ref":"#/components/schemas/TransactionResponseStatus"},"pos_slug":{"type":"string","description":"Slug of the point of sale"},"three_d_used":{"type":"boolean","description":"Indicates if 3D Secure was used"}}},"TransactionType":{"type":"string","description":"Type of transaction","enum":["authorize","capture","purchase","refund","void","purchase_three_d","redirect","webhook","store_card","return_back","init","capture_refund","pre_purchase"]},"Pos":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the POS (Point of Sale) system."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the POS system."},"name":{"type":"string","maxLength":64,"description":"Name of the POS system."},"slug":{"type":"string","maxLength":64,"description":"Unique slug used to identify the POS system."},"gateway":{"type":"string","maxLength":128,"enum":["garanti","nestpay","cmi","posnet","payu","mastercard","masterpass","bex","hyperpay","payu_poland","payu_romania","payu_ro","fastpay","maximumpay","liqpay","gpay","easypay","mobilexpress","mobilexpress_credit_card","iyzico","iyzico_bkm","finansbank","denizbank","yandex_money","paypal","alpha","dummypay","ykb_credit","compay","compay_credit","param","garanti_switch","pay_with_iyzico","tompay","iyzico_funds_transfer","paycell","posas_giftcard","multisafepay","garanti_credit","multisafepay_direct","ozan","netopia","teqpay","payu_pl","stripe","bulut","fiba_credit","mobilexpress_hosted","paymob","tompay_credit","paytr","payzee","mobilexpress_v8_cc","ykb_worldpay","extension","vakifbank","bulut_direct","eren_card","craftgate","iyzico_saved_card","checkout","checkout_apple_pay","zip_credit","mobilexpress_wire_transfer","payu_ro_paybyclick","payu_ro_saved_card","paybyme","sipay","paywall","dummy_psp","tap","qpay_tap","tap_saved_card","akbank","hepsipay","qnb_pay"],"description":"Payment gateway associated with the POS system. This field represents an enumerated value."},"resource_url":{"type":"string","format":"uri","description":"URL of the POS resource."},"three_d_resource_url":{"type":"string","format":"uri","nullable":true,"description":"Optional URL for 3D secure payments via the POS system."},"config":{"type":"object","additionalProperties":{"type":"string"},"description":"JSON configuration for the POS system settings."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the POS system was last modified."}},"required":["name","slug","gateway","resource_url","channel"],"description":"The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field."},"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"}}},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"PaymentOption":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the payment option."},"name":{"type":"string","maxLength":128,"description":"Name of the payment option (translatable)."},"slug":{"type":"string","maxLength":128,"description":"Slug representing the payment option."},"payment_type":{"type":"string","maxLength":64,"enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Type of payment represented by the option."},"sort_order":{"type":"integer","default":0,"description":"Sort order for displaying the payment option."},"config":{"type":"object","additionalProperties":true,"description":"JSON configuration for the payment option."},"is_active":{"type":"boolean","default":true,"description":"Status of the payment option."},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"The channel associated with this payment option."},"translations":{"type":"object","additionalProperties":true,"nullable":true,"description":"Translations for the payment option's name (if applicable)."}},"required":["name","slug","payment_type","channel"],"description":"Payment option representing various payment methods with translatable fields."},"Installment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the installment."},"bank_interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate applied by the bank.","nullable":true},"card":{"$ref":"#/components/schemas/Card","description":"Reference to the associated payment card."},"installment_count":{"type":"integer","format":"int32","description":"Number of installments.","default":1},"label":{"type":"string","maxLength":16,"description":"Label describing the installment plan."},"interest_rate":{"type":"number","format":"decimal","maximum":9999.999999,"description":"Interest rate for the installment."},"is_active":{"type":"boolean","default":true,"description":"Whether the installment plan is active."},"config":{"type":"object","additionalProperties":true,"description":"Configuration details for the installment plan in JSON format."},"translations":{"type":"object","nullable":true,"description":"Translations for the installment plan (if applicable)."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the installment plan was last modified"}},"required":["card","installment_count","label","interest_rate","is_active"],"description":"The Installment model represents payment installment plans associated with payment cards, including interest rates and configuration details. Each installment plan can be translated into multiple languages, and it supports integration with external systems."},"Card":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card."},"name":{"type":"string","maxLength":64,"description":"Name of the card."},"slug":{"type":"string","maxLength":64,"description":"Slug used for URL generation."},"bank":{"$ref":"#/components/schemas/Bank","description":"Reference to the associated bank."},"card_type":{"$ref":"#/components/schemas/CardType","description":"Reference to the card type."},"card_payment_type":{"type":"string","description":"The payment type of the card.","enum":["credit","debit"]},"cash_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for cash payments."},"installment_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for installment payments."},"three_d_payment":{"$ref":"#/components/schemas/Pos","description":"Reference to the POS for 3D secure payments (optional).","nullable":true},"is_commerce_card":{"type":"boolean","default":false,"description":"Whether the card is a commerce card."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}},"required":["name","slug","bank","card_type","card_payment_type","cash_payment","installment_payment"],"description":"The Card model represents a payment card with its associated bank, card type, and payment methods (cash, installment, and 3D secure). It can also indicate whether the card is a commerce card for special transactions. The model supports integration with external systems via the IntegrationRelation."},"Bank":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the bank."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the bank."},"name":{"type":"string","maxLength":64,"description":"Name of the bank."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the bank, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the bank's logo image (optional).","nullable":true},"integration":{"type":"object","description":"Integration data for linking with external systems.","nullable":true},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the bank was last modified."}},"required":["name","slug","channel"],"description":"The Bank model represents a financial institution. It contains key information like the bank's name, slug, logo image, and its relationship with a channel. The bank can also be integrated with external systems through the integration field."},"CardType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the card type."},"channel":{"$ref":"#/components/schemas/Channel","description":"Reference to the channel associated with the card type."},"name":{"type":"string","maxLength":64,"description":"Name of the card type."},"slug":{"type":"string","maxLength":64,"description":"Unique slug for the card type, used for URL generation."},"logo":{"type":"string","format":"uri","description":"URL to the card type's logo image."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the card type was last modified."}},"required":["name","slug","channel","logo"],"description":"The CardType model represents the type of a payment card (e.g., debit card, credit card) and contains key information such as the name, slug, and logo. It is associated with a specific channel and can be linked to external systems via the integration field."},"CargoCompany":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier of the cargo company."},"name":{"type":"string","description":"Name of the cargo company.","maxLength":64},"erp_code":{"type":"string","description":"Unique ERP code associated with the cargo company.","maxLength":64},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"}}},"FundsTransferTransactionReadOnly":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the funds transfer transaction"},"order":{"type":"integer","description":"ID of the related order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"chosen_bank_account":{"$ref":"#/components/schemas/BankAccount"},"date_paid":{"type":"string","format":"date-time","description":"Date when the payment was made"},"paid_bank_account":{"$ref":"#/components/schemas/BankAccount"},"user_holder_name":{"type":"string","description":"Name of the user associated with the transaction"},"user_iban":{"type":"string","description":"IBAN of the user associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/FundsTransferTransactionStatus"},"pos":{"type":"integer","description":"ID of the related point of sale"},"raw_request":{"type":"string","description":"Raw request data associated with the transaction"},"raw_response":{"type":"string","description":"Raw response data associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"reference_code":{"type":"string","description":"Reference code for the transaction"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}}},"BankAccount":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the bank account"},"bank":{"type":"integer","description":"ID of the associated bank"},"slug":{"type":"string","description":"Slug for the bank account"},"holder_name":{"type":"string","description":"Name of the account holder"},"iban":{"type":"string","description":"International Bank Account Number (IBAN)"},"is_active":{"type":"boolean","description":"Indicates if the bank account is active"},"sort_order":{"type":"integer","description":"Sort order of the bank account"},"description":{"type":"string","description":"Description of the bank account"},"channel":{"type":"integer","description":"ID of the associated channel"}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]},"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"]},"PayOnDeliveryTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"amount":{"type":"number","format":"float","description":"Amount of the transaction"},"payment_type":{"type":"string","description":"Type of payment"},"handling_fee":{"type":"number","format":"float","description":"Handling fee for the transaction"},"transaction_type":{"$ref":"#/components/schemas/PayOnDeliveryTransactionType"},"status":{"$ref":"#/components/schemas/PayOnDeliveryTransactionStatus"}}},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]},"LoyaltyTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"required":["uuid","amount","order","user_email","transaction_type","customer_email"],"properties":{"pk":{"type":"integer","description":"Primary key of the loyalty transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the loyalty transaction."},"amount":{"type":"number","format":"decimal","description":"Transaction amount."},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","format":"email","description":"Email of the user who performed the transaction."},"transaction_type":{"$ref":"#/components/schemas/LoyaltyTransactionType"},"customer":{"$ref":"#/components/schemas/Customer"},"customer_email":{"type":"string","format":"email","description":"Email of the customer involved in the transaction."},"raw_request":{"type":"string","nullable":true,"description":"Raw request data (optional)."},"raw_response":{"type":"string","nullable":true,"description":"Raw response data (optional)."},"reference":{"type":"string","description":"Reference identifier for the transaction.","nullable":true},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the transaction was initiated."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"BexTransactionDetailed":{"properties":{"pk":{"type":"integer","description":"Primary key of the transaction"},"transaction_type":{"$ref":"#/components/schemas/BexTransactionType"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"pos":{"$ref":"#/components/schemas/Pos"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]},"B2BTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the B2B transaction"},"order":{"type":"integer","description":"ID of the associated order"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the B2B transaction"},"transaction_type":{"$ref":"#/components/schemas/B2BTransactionType"},"user_email":{"type":"string","description":"Email of the user associated with the B2B transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the B2B transaction"},"created_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was created"},"modified_date":{"type":"string","format":"date-time","description":"Date when the B2B transaction was last modified"}}},"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]},"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"}}},"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}}},"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"}}},"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}}},"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"]},"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"}}},"CashRegisterTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the cash register transaction"},"transaction_id":{"type":"string","description":"Unique identifier for the transaction"},"order":{"type":"integer","description":"ID of the associated order"},"user_email":{"type":"string","description":"Email of the user associated with the transaction"},"raw_request":{"type":"string","description":"Raw request data for the transaction"},"raw_response":{"type":"string","description":"Raw response data for the transaction"},"amount":{"type":"number","format":"decimal","description":"Amount involved in the transaction"},"remote_addr":{"type":"string","description":"Remote address associated with the transaction"},"staff_id":{"type":"integer","description":"ID of the staff associated with the transaction"},"staff_remote_id":{"type":"string","description":"Remote ID of the staff associated with the transaction"},"staff_email":{"type":"string","description":"Email of the staff associated with the transaction"},"store_id":{"type":"integer","description":"ID of the store associated with the transaction"},"store_remote_id":{"type":"string","description":"Remote ID of the store associated with the transaction"},"transaction_type":{"$ref":"#/components/schemas/CashRegisterTransactionType"},"is_succeeded":{"type":"boolean","description":"Indicates if the transaction was successful"}}},"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]},"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]},"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}},"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"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}}}},"paths":{"/api/v1/channel/{channel_id}/orders/{id}/cancellation_reject_order/":{"post":{"tags":["SalesChannelOrders"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"summary":"Cancel an order","description":"Reject a cancellation of an order with the specified ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"An empty dictionary"}}}},"responses":{"200":{"description":"Order successfully cancelled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"}}}}}}
```