# Models ## The Customer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The CustomerDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CustomerDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/Customer"}],"properties":{"channel":{"$ref":"#/components/schemas/Channel"},"orders_info":{"type":"object","properties":{"total_order_amount":{"type":"number","nullable":true},"total_refund_amount":{"type":"number","nullable":true},"total_discount_amount":{"type":"number","nullable":true},"total_order_count":{"type":"integer"}}}}},"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"]},"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"}}}}}} ``` ## The DeletedItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"DeletedItem":{"type":"object","properties":{"id":{"type":"integer"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"string"},"deleted_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"]}}}} ``` ## The PaymentOption object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."},"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"}}}}}} ``` ## The Bank object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."},"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"}}}}}} ``` ## The CardType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."},"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"}}}}}} ``` ## The BankAccount object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}}}}} ``` ## The Pos object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."},"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"}}}}}} ``` ## The Card object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."},"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"}}},"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."},"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."}}}} ``` ## The Installment object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."},"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"}}},"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."},"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."}}}} ``` ## The AttributeSet object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"AttributeSet":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"channel":{"type":"integer","nullable":true},"remote_id":{"type":"string","maxLength":255,"nullable":true},"created_date":{"type":"string","format":"date-time"},"modified_date":{"type":"string","format":"date-time"}}}}}} ``` ## The AttributeValue object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"AttributeValue":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"attribute":{"$ref":"#/components/schemas/Attribute"},"label":{"type":"string","nullable":true,"description":"The display label of the attribute value"},"value":{"type":"string","description":"The actual value of the attribute"},"order":{"type":"integer","nullable":true,"description":"Order of the attribute value"},"erp_code":{"type":"string","maxLength":255,"description":"ERP code for integration purposes"},"created_date":{"type":"string","format":"date-time","description":"Date and time when the attribute value was created"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the attribute value was last modified"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"Attribute":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"default_value":{"$ref":"#/components/schemas/AttributeValue"},"entity_type":{"$ref":"#/components/schemas/ContentType"},"erp_code":{"type":"string","maxLength":255,"description":"ERP code for integration purposes"},"pre_attribute":{"type":"boolean","description":"Is this attribute a pre-attribute?"},"description":{"type":"string","nullable":true,"description":"Description of the attribute"},"name":{"type":"string","maxLength":255,"description":"Name of the attribute"},"key":{"type":"string","maxLength":255,"description":"Key of the attribute"},"data_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["text","email","text_area","date","datetime","boolean","valuelabel","dropdown","multiple","price","nested_object","image","file","model","bundle"]}}},"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"]}}}} ``` ## The ProductImage object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductImage":{"type":"object","description":"Represents an image associated with a product, used for display in sales channels or internal listings.","properties":{"pk":{"type":"integer","description":"Unique identifier for the product image.","readOnly":true},"product":{"type":"integer","description":"ID of the associated product."},"source":{"type":"string","nullable":true,"description":"The source of the image (e.g., 'unified').","enum":["unified","integration","seller_center"]},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the image was last modified."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the image was created.","readOnly":true},"height":{"type":"integer","nullable":true,"description":"Height of the image in pixels."},"width":{"type":"integer","nullable":true,"description":"Width of the image in pixels."},"hash":{"type":"string","nullable":true,"description":"A hash of the image content used for deduplication or versioning."},"status":{"type":"string","description":"Status of the image (e.g., active). Read-only.","enum":["active","disabled"]},"is_active":{"type":"boolean","description":"Indicates whether the image is currently active and should be used."},"order":{"type":"integer","description":"Display order for the image among other images of the same product."},"object_id":{"type":"integer","description":"ID of the target object this configuration applies to."},"content_type":{"type":"string","description":"The model name of the target object's content type."}}}}}} ``` ## The SpecialImage object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SpecialImage":{"type":"object","description":"Model representing a special image for a product","required":["product","product_image","image_type"],"properties":{"id":{"type":"integer","readOnly":true,"description":"Unique identifier for the special image"},"product":{"type":"integer","description":"Foreign key to the associated product"},"product_image":{"type":"integer","description":"Foreign key to the associated product image"},"image_type":{"type":"string","description":"Type of the special image","enum":["base","swatch","listing","picto"]}}}}}} ``` ## The ProductImageNestedSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductImageNestedSerializer":{"type":"object","description":"Represents an image associated with a product, used for display in sales channels or internal listings.","properties":{"pk":{"type":"integer","description":"Unique identifier for the product image.","readOnly":true},"status":{"type":"string","description":"Status of the image (e.g., active). Read-only.","enum":["active","disabled"]},"order":{"type":"integer","description":"Display order for the image among other images of the same product."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the image was created.","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the image was last modified."},"specialimage_set":{"type":"array","items":{"$ref":"#/components/schemas/SpecialImage"},"description":"List of special images associated with this product image."},"image":{"type":"string","format":"binary","description":"The product image file."}}},"SpecialImage":{"type":"object","description":"Model representing a special image for a product","required":["product","product_image","image_type"],"properties":{"id":{"type":"integer","readOnly":true,"description":"Unique identifier for the special image"},"product":{"type":"integer","description":"Foreign key to the associated product"},"product_image":{"type":"integer","description":"Foreign key to the associated product image"},"image_type":{"type":"string","description":"Type of the special image","enum":["base","swatch","listing","picto"]}}}}}} ``` ## The Product object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The ProductSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductSerializer":{"allOf":[{"$ref":"#/components/schemas/Product"},{"type":"object"}],"properties":{"data_source":{"$ref":"#/components/schemas/DataSource"}}},"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"]},"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"]},"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."}}}}}} ``` ## The ProductDetailedSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductDetailedSerializer":{"allOf":[{"$ref":"#/components/schemas/ProductSerializer"},{"type":"object"}],"properties":{"parent":{"$ref":"#/components/schemas/ProductSerializer"},"group_products":{"type":"array","items":{"$ref":"#/components/schemas/ProductSerializer"},"description":"List of product IDs in the group","readOnly":true},"productimage_set":{"type":"array","items":{"$ref":"#/components/schemas/ProductImageNestedSerializer"},"description":"List of images associated with the product","readOnly":true},"attribute_set":{"$ref":"#/components/schemas/AttributeSet"},"custom_attribute_set":{"$ref":"#/components/schemas/AttributeSet"}}},"ProductSerializer":{"allOf":[{"$ref":"#/components/schemas/Product"},{"type":"object"}],"properties":{"data_source":{"$ref":"#/components/schemas/DataSource"}}},"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"]},"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"]},"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."}}},"ProductImageNestedSerializer":{"type":"object","description":"Represents an image associated with a product, used for display in sales channels or internal listings.","properties":{"pk":{"type":"integer","description":"Unique identifier for the product image.","readOnly":true},"status":{"type":"string","description":"Status of the image (e.g., active). Read-only.","enum":["active","disabled"]},"order":{"type":"integer","description":"Display order for the image among other images of the same product."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the image was created.","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the image was last modified."},"specialimage_set":{"type":"array","items":{"$ref":"#/components/schemas/SpecialImage"},"description":"List of special images associated with this product image."},"image":{"type":"string","format":"binary","description":"The product image file."}}},"SpecialImage":{"type":"object","description":"Model representing a special image for a product","required":["product","product_image","image_type"],"properties":{"id":{"type":"integer","readOnly":true,"description":"Unique identifier for the special image"},"product":{"type":"integer","description":"Foreign key to the associated product"},"product_image":{"type":"integer","description":"Foreign key to the associated product image"},"image_type":{"type":"string","description":"Type of the special image","enum":["base","swatch","listing","picto"]}}},"AttributeSet":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"channel":{"type":"integer","nullable":true},"remote_id":{"type":"string","maxLength":255,"nullable":true},"created_date":{"type":"string","format":"date-time"},"modified_date":{"type":"string","format":"date-time"}}}}}} ``` ## The ProductList object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductList":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of records"},"next":{"type":"string","nullable":true,"format":"uri","description":"URL of the next page"},"previous":{"type":"string","nullable":true,"format":"uri","description":"URL of the previous page"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ProductSerializer"},"description":"List of results"}}},"ProductSerializer":{"allOf":[{"$ref":"#/components/schemas/Product"},{"type":"object"}],"properties":{"data_source":{"$ref":"#/components/schemas/DataSource"}}},"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"]},"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"]},"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."}}}}}} ``` ## The ProductDetailedList object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductDetailedList":{"allOf":[{"$ref":"#/components/schemas/ProductList"},{"type":"object"}],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetailedSerializer"},"description":"List of detailed results"}}},"ProductList":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of records"},"next":{"type":"string","nullable":true,"format":"uri","description":"URL of the next page"},"previous":{"type":"string","nullable":true,"format":"uri","description":"URL of the previous page"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ProductSerializer"},"description":"List of results"}}},"ProductSerializer":{"allOf":[{"$ref":"#/components/schemas/Product"},{"type":"object"}],"properties":{"data_source":{"$ref":"#/components/schemas/DataSource"}}},"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"]},"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"]},"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."}}},"ProductDetailedSerializer":{"allOf":[{"$ref":"#/components/schemas/ProductSerializer"},{"type":"object"}],"properties":{"parent":{"$ref":"#/components/schemas/ProductSerializer"},"group_products":{"type":"array","items":{"$ref":"#/components/schemas/ProductSerializer"},"description":"List of product IDs in the group","readOnly":true},"productimage_set":{"type":"array","items":{"$ref":"#/components/schemas/ProductImageNestedSerializer"},"description":"List of images associated with the product","readOnly":true},"attribute_set":{"$ref":"#/components/schemas/AttributeSet"},"custom_attribute_set":{"$ref":"#/components/schemas/AttributeSet"}}},"ProductImageNestedSerializer":{"type":"object","description":"Represents an image associated with a product, used for display in sales channels or internal listings.","properties":{"pk":{"type":"integer","description":"Unique identifier for the product image.","readOnly":true},"status":{"type":"string","description":"Status of the image (e.g., active). Read-only.","enum":["active","disabled"]},"order":{"type":"integer","description":"Display order for the image among other images of the same product."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the image was created.","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the image was last modified."},"specialimage_set":{"type":"array","items":{"$ref":"#/components/schemas/SpecialImage"},"description":"List of special images associated with this product image."},"image":{"type":"string","format":"binary","description":"The product image file."}}},"SpecialImage":{"type":"object","description":"Model representing a special image for a product","required":["product","product_image","image_type"],"properties":{"id":{"type":"integer","readOnly":true,"description":"Unique identifier for the special image"},"product":{"type":"integer","description":"Foreign key to the associated product"},"product_image":{"type":"integer","description":"Foreign key to the associated product image"},"image_type":{"type":"string","description":"Type of the special image","enum":["base","swatch","listing","picto"]}}},"AttributeSet":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"channel":{"type":"integer","nullable":true},"remote_id":{"type":"string","maxLength":255,"nullable":true},"created_date":{"type":"string","format":"date-time"},"modified_date":{"type":"string","format":"date-time"}}}}}} ``` ## The Attribute object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Attribute":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"default_value":{"$ref":"#/components/schemas/AttributeValue"},"entity_type":{"$ref":"#/components/schemas/ContentType"},"erp_code":{"type":"string","maxLength":255,"description":"ERP code for integration purposes"},"pre_attribute":{"type":"boolean","description":"Is this attribute a pre-attribute?"},"description":{"type":"string","nullable":true,"description":"Description of the attribute"},"name":{"type":"string","maxLength":255,"description":"Name of the attribute"},"key":{"type":"string","maxLength":255,"description":"Key of the attribute"},"data_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["text","email","text_area","date","datetime","boolean","valuelabel","dropdown","multiple","price","nested_object","image","file","model","bundle"]}}},"AttributeValue":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"attribute":{"$ref":"#/components/schemas/Attribute"},"label":{"type":"string","nullable":true,"description":"The display label of the attribute value"},"value":{"type":"string","description":"The actual value of the attribute"},"order":{"type":"integer","nullable":true,"description":"Order of the attribute value"},"erp_code":{"type":"string","maxLength":255,"description":"ERP code for integration purposes"},"created_date":{"type":"string","format":"date-time","description":"Date and time when the attribute value was created"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the attribute value was last modified"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"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"]}}}} ``` ## The Provider object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Provider":{"type":"object","properties":{"name":{"type":"string","maxLength":256,"description":"The name of the OAuth provider."},"slug":{"type":"string","maxLength":256,"description":"A unique slug identifier for the provider."},"icon":{"type":"string","format":"uri","description":"URL of the provider's icon."},"client_id":{"type":"string","maxLength":256,"description":"Client ID for the OAuth provider."},"client_secret":{"type":"string","maxLength":512,"description":"Client secret for the OAuth provider."},"authorization_url":{"type":"string","format":"uri","maxLength":512,"description":"The URL for the authorization endpoint of the provider."},"token_url":{"type":"string","format":"uri","maxLength":512,"description":"The URL for the token endpoint of the provider."},"userinfo_url":{"type":"string","format":"uri","maxLength":512,"description":"The URL for the user information endpoint of the provider."},"whitelist":{"type":"array","items":{"type":"string","format":"uri","maxLength":512},"description":"A list of URLs whitelisted for the provider."},"provider":{"type":"string","maxLength":32,"enum":["azure","github","google","turkcell"],"description":"The type of provider. Possible values: `azure`, `github`, `google`, `turkcell`."},"kwargs":{"type":"object","description":"Additional parameters for the provider."},"is_active":{"type":"boolean","description":"Indicates whether the provider is active."}}}}}} ``` ## The LDAPProvider object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"LDAPProvider":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"LDAP Provider ID"},"name":{"type":"string","maxLength":256,"description":"Name of the LDAP provider."},"slug":{"type":"string","maxLength":256,"description":"Unique slug for the LDAP provider."},"icon":{"type":"string","format":"binary","description":"Icon for the LDAP provider."},"host":{"type":"string","format":"url","description":"Host URL for the LDAP provider."},"port":{"type":"integer","description":"Port number to connect to the LDAP server.","maximum":65535},"use_ssl":{"type":"boolean","description":"Indicates whether SSL is used for the LDAP connection."},"bind_dn":{"type":"string","maxLength":256,"description":"The distinguished name (DN) for binding to the LDAP server."},"bind_password":{"type":"string","maxLength":512,"description":"Password for the LDAP bind user."},"base_dn":{"type":"string","maxLength":256,"description":"The base distinguished name (DN) for LDAP searches."},"attribute_map":{"type":"object","description":"A mapping of LDAP attributes to system fields."},"is_active":{"type":"boolean","description":"Indicates if the LDAP provider is active."}}}}}} ``` ## The LoyaltyTransaction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}},"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."}}},"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]},"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"]}}}} ``` ## The Policy object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy ID","readOnly":true},"users":{"type":"array","items":{"type":"integer"},"description":"List of users associated with the policy."},"fe_permission_groups":{"type":"array","items":{"type":"integer"},"description":"List of frontend permission groups associated with the policy."},"accept_languages":{"type":"array","items":{"type":"string","maxLength":10},"description":"List of accepted language codes. If empty, all languages are accepted."},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"}}}}}} ``` ## The SortOption object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SortOption":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"type":"integer"}},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true}}},"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."}}}}}} ``` ## The SortOptionDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"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."}}}}}} ``` ## The SortingAlgorithm object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"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."}}}}}} ``` ## The Export object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Export":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true,"description":"Unique identifier for the export."},"action_name":{"type":"string","nullable":true,"maxLength":255,"description":"Name of the export action."},"collected_count":{"type":"integer","format":"int32","default":0,"description":"Number of records collected for the export."},"error_message":{"type":"string","nullable":true},"fail_count":{"type":"integer","format":"int32","default":0,"description":"Number of records that failed to export."},"filter_file":{"type":"string","format":"binary","nullable":true,"description":"Path to the uploaded filter file."},"format_type":{"type":"string","enum":["csv","xls","json"],"default":"csv","description":"File format for the export."},"language":{"type":"string","maxLength":8,"description":"Language code for the export."},"last_instance_id":{"type":"integer","format":"int32","default":0,"description":"ID of the last record exported."},"page":{"type":"integer","format":"int32","default":1,"description":"Current page number for the export."},"request_fields":{"type":"array","items":{"type":"string"},"description":"List of fields requested for the export."},"request_path":{"type":"string","description":"API path to request data for the export."},"requested_by":{"type":"string","format":"uuid","description":"ID of the user who requested the export."},"result_file":{"type":"string","nullable":true,"maxLength":512,"description":"Path or URL to the result file."},"total_count":{"type":"integer","format":"int32","default":0,"description":"Total number of records to be exported."},"status":{"type":"string","enum":["waiting","waiting_next_page","processing","completed","failed","cancelled","preparing_file_creation"],"default":"waiting"},"uploaded_parts":{"type":"array","items":{"type":"string"},"description":"List of uploaded file parts."},"viewset":{"type":"string","nullable":true,"maxLength":255,"description":"The name of the viewset associated with the export."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}}}}} ``` ## The BaseProductCollection object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BaseProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"name":{"type":"string","description":"Name of the product collection","maxLength":255},"slug":{"type":"string","description":"Unique slug identifier for the product collection","maxLength":255},"is_active":{"type":"boolean","description":"Whether the product collection is active","default":true},"sort_option":{"type":"integer","description":"Foreign key to SortOption model","nullable":true},"expiration_date":{"type":"string","format":"date-time","description":"Date and time when the collection expires","nullable":true},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":true}}},"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."}}}}}} ``` ## The ProductCollection object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseProductCollection"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product collection"},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":false},"catalog":{"type":"integer","description":"Foreign key to Catalog model"},"kwargs":{"type":"object","description":"Dynamic configuration stored as JSON","additionalProperties":true},"value_dict":{"type":"object","description":"Dictionary of filter values for dynamic collections","additionalProperties":true},"selected_filters":{"type":"array","description":"List of selected filters for the collection","items":{"type":"string"}},"is_dynamic":{"type":"boolean","description":"Whether the collection is dynamic","readOnly":true}}},"BaseProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"name":{"type":"string","description":"Name of the product collection","maxLength":255},"slug":{"type":"string","description":"Unique slug identifier for the product collection","maxLength":255},"is_active":{"type":"boolean","description":"Whether the product collection is active","default":true},"sort_option":{"type":"integer","description":"Foreign key to SortOption model","nullable":true},"expiration_date":{"type":"string","format":"date-time","description":"Date and time when the collection expires","nullable":true},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":true}}},"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."}}},"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"}}}} ``` ## The ProductCollectionHyperSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductCollectionHyperSerializer":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProductCollection"}],"properties":{"url":{"type":"string","format":"uri","description":"URL for the product collection"},"catalog":{"type":"string","format":"uri","description":"URL for the catalog"},"sort_option":{"type":"string","format":"uri","description":"URL for the sort option","nullable":true}}},"ProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseProductCollection"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product collection"},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":false},"catalog":{"type":"integer","description":"Foreign key to Catalog model"},"kwargs":{"type":"object","description":"Dynamic configuration stored as JSON","additionalProperties":true},"value_dict":{"type":"object","description":"Dictionary of filter values for dynamic collections","additionalProperties":true},"selected_filters":{"type":"array","description":"List of selected filters for the collection","items":{"type":"string"}},"is_dynamic":{"type":"boolean","description":"Whether the collection is dynamic","readOnly":true}}},"BaseProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"name":{"type":"string","description":"Name of the product collection","maxLength":255},"slug":{"type":"string","description":"Unique slug identifier for the product collection","maxLength":255},"is_active":{"type":"boolean","description":"Whether the product collection is active","default":true},"sort_option":{"type":"integer","description":"Foreign key to SortOption model","nullable":true},"expiration_date":{"type":"string","format":"date-time","description":"Date and time when the collection expires","nullable":true},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":true}}},"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."}}},"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"}}}} ``` ## The ProductCollectionDetailedSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductCollectionDetailedSerializer":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProductCollection"}],"properties":{"catalog":{"type":"object","description":"Catalog object"},"sort_option":{"type":"object","description":"Sort option object"}}},"ProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseProductCollection"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product collection"},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":false},"catalog":{"type":"integer","description":"Foreign key to Catalog model"},"kwargs":{"type":"object","description":"Dynamic configuration stored as JSON","additionalProperties":true},"value_dict":{"type":"object","description":"Dictionary of filter values for dynamic collections","additionalProperties":true},"selected_filters":{"type":"array","description":"List of selected filters for the collection","items":{"type":"string"}},"is_dynamic":{"type":"boolean","description":"Whether the collection is dynamic","readOnly":true}}},"BaseProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"name":{"type":"string","description":"Name of the product collection","maxLength":255},"slug":{"type":"string","description":"Unique slug identifier for the product collection","maxLength":255},"is_active":{"type":"boolean","description":"Whether the product collection is active","default":true},"sort_option":{"type":"integer","description":"Foreign key to SortOption model","nullable":true},"expiration_date":{"type":"string","format":"date-time","description":"Date and time when the collection expires","nullable":true},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":true}}},"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."}}},"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"}}}} ``` ## The ProductCollectionDetailedHyperSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductCollectionDetailedHyperSerializer":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProductCollectionDetailedSerializer"}],"properties":{"url":{"type":"string","format":"uri","description":"URL for the product collection"},"catalog":{"type":"string","format":"uri","description":"URL for the catalog"},"sort_option":{"type":"string","format":"uri","description":"URL for the sort option","nullable":true}}},"ProductCollectionDetailedSerializer":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProductCollection"}],"properties":{"catalog":{"type":"object","description":"Catalog object"},"sort_option":{"type":"object","description":"Sort option object"}}},"ProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseProductCollection"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product collection"},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":false},"catalog":{"type":"integer","description":"Foreign key to Catalog model"},"kwargs":{"type":"object","description":"Dynamic configuration stored as JSON","additionalProperties":true},"value_dict":{"type":"object","description":"Dictionary of filter values for dynamic collections","additionalProperties":true},"selected_filters":{"type":"array","description":"List of selected filters for the collection","items":{"type":"string"}},"is_dynamic":{"type":"boolean","description":"Whether the collection is dynamic","readOnly":true}}},"BaseProductCollection":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"name":{"type":"string","description":"Name of the product collection","maxLength":255},"slug":{"type":"string","description":"Unique slug identifier for the product collection","maxLength":255},"is_active":{"type":"boolean","description":"Whether the product collection is active","default":true},"sort_option":{"type":"integer","description":"Foreign key to SortOption model","nullable":true},"expiration_date":{"type":"string","format":"date-time","description":"Date and time when the collection expires","nullable":true},"collection_type":{"type":"string","enum":["static","dynamic"],"description":"Type of the product collection","nullable":true}}},"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."}}},"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"}}}} ``` ## The User object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}}}}} ``` ## The TOTPSetup object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TOTPSetup":{"type":"object","properties":{"secret_key":{"type":"string","description":"TOTP secret key"},"provisioning_uri":{"type":"string","description":"TOTP provisioning URI"}}}}}} ``` ## The TOTPActivate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TOTPActivate":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"TOTP verification code"}}}}}} ``` ## The TOTPActivateResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TOTPActivateResponse":{"type":"object","properties":{"recovery_codes":{"type":"array","description":"Recovery codes","items":{"type":"string"}}}}}}} ``` ## The TOTPDeactivateResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TOTPDeactivateResponse":{"type":"object","properties":{"detail":{"type":"string","description":"Success message"}}}}}} ``` ## The TOTPVerify object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TOTPVerify":{"type":"object","required":["temp_token","token"],"properties":{"temp_token":{"type":"string","description":"Temporary token received from initial login"},"token":{"type":"string","description":"TOTP verification code"}}}}}} ``` ## The TOTPVerifyResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TOTPVerifyResponse":{"type":"object","properties":{"key":{"type":"string","description":"Login token"}}}}}} ``` ## The StockList object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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}}},"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."}}}}}} ``` ## The PriceList object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]}}}} ``` ## The ProductPrice object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductPrice":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Product Price ID"},"product":{"type":"integer","nullable":false,"description":"ID of the product related with the price."},"price_list":{"type":"integer","nullable":false,"description":"ID of the price list related with the price."},"retail_price":{"type":"number","format":"decimal","nullable":true,"description":"Retail price of the product, can be null or blank."},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate applied to the product price."},"currency_type":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"The actual price of the product."},"price_type":{"type":"string","description":"Type of the price.","enum":["default","range_"]},"discount_percentage":{"type":"number","format":"decimal","description":"Discount percentage applied to the price, if any."},"extra_field":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Extra fields related to the product price in JSON format."},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Product Price"},"modified_date":{"type":"string","format":"date-time","description":"Modification Date of the Product Price"}}},"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"]}}}} ``` ## The ProductPriceDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductPriceDetailed":{"allOf":[{"$ref":"#/components/schemas/ProductPrice"}],"properties":{"product":{"$ref":"#/components/schemas/Product"},"price_list":{"$ref":"#/components/schemas/PriceList"}}},"ProductPrice":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Product Price ID"},"product":{"type":"integer","nullable":false,"description":"ID of the product related with the price."},"price_list":{"type":"integer","nullable":false,"description":"ID of the price list related with the price."},"retail_price":{"type":"number","format":"decimal","nullable":true,"description":"Retail price of the product, can be null or blank."},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate applied to the product price."},"currency_type":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"The actual price of the product."},"price_type":{"type":"string","description":"Type of the price.","enum":["default","range_"]},"discount_percentage":{"type":"number","format":"decimal","description":"Discount percentage applied to the price, if any."},"extra_field":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Extra fields related to the product price in JSON format."},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Product Price"},"modified_date":{"type":"string","format":"date-time","description":"Modification Date of the Product Price"}}},"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"]},"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"}}}}}} ``` ## The ProductStock object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductStock":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true},"product":{"type":"integer"},"unit_type":{"type":"string","enum":["qty","kg"]},"stock":{"type":"integer"},"sold_quantity_unreported":{"type":"integer"},"extra_field":{"type":"object"},"stock_list":{"type":"integer","description":"Related Stock List"},"created_date":{"type":"string","format":"date-time"},"modified_date":{"type":"string","format":"date-time"}}}}}} ``` ## The CategoryTree object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNode"}}},"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."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}}}} ``` ## The CategoryTreeDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CategoryTreeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNodeDetailed"}}},"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."}}},"CategoryNodeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"object","$ref":"#/components/schemas/SortOptionDetailed"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}},"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]}}}} ``` ## The CategoryNode object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}}}} ``` ## The CategoryNodeDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CategoryNodeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"object","$ref":"#/components/schemas/SortOptionDetailed"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}},"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"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."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]}}}} ``` ## The CategoryNodeCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CategoryNodeCreate":{"type":"object","required":["name","node"],"properties":{"name":{"type":"string","description":"Name of the category node","maxLength":64},"order":{"type":"integer","description":"Order of the category node within its level"},"node":{"type":"string","description":"Parent node information for creating child category node"},"sort_option":{"type":"integer","nullable":true,"description":"ID of the sort option for the category node"},"attributes":{"type":"object","description":"Dynamic attributes for the category node","nullable":true}}}}}} ``` ## The CategoryNodeUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CategoryNodeUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Name of the category node","maxLength":64},"order":{"type":"integer","description":"Order of the category node"},"sort_option":{"type":"integer","nullable":true,"description":"ID of the sort option for the category node"},"attributes":{"type":"object","description":"Dynamic attributes for the category node"}}}}}} ``` ## The CategoryNodeMove object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CategoryNodeMove":{"type":"object","required":["node","target","pos"],"properties":{"node":{"type":"integer","description":"ID of the node to move (must have depth greater than 1)"},"target":{"type":"integer","description":"ID of the target node to move to (must have depth greater than 1)"},"pos":{"type":"string","enum":["left","right"],"description":"Position relative to the target node"}}}}}} ``` ## The District object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."}}}}}} ``` ## The DistrictDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"DistrictDetailed":{"allOf":[{"$ref":"#/components/schemas/District"}],"properties":{"city":{"$ref":"#/components/schemas/City"},"township":{"$ref":"#/components/schemas/Township"}}},"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"]},"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."}}},"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"]}}}} ``` ## The Address object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Address":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"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":{"type":"integer","description":"Related country ID"},"city":{"type":"integer","description":"Related city ID"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"type":"integer","description":"Related township ID"},"district":{"type":"integer","description":"Related district ID"},"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":{"type":"integer","description":"Related retail store ID"},"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":{"type":"integer","description":"Related customer ID"},"is_active":{"type":"boolean","description":"Indicates if the address is active"}},"required":["phone_number"]},"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."}}},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}}}} ``` ## The AddressDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The City object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The CityDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CityDetailed":{"allOf":[{"$ref":"#/components/schemas/City"}],"properties":{"country":{"$ref":"#/components/schemas/Country"}}},"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"]},"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"]}}}} ``` ## The Country object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The Township object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}}}}} ``` ## The TownshipDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TownshipDetailed":{"allOf":[{"$ref":"#/components/schemas/Township"}],"properties":{"city":{"$ref":"#/components/schemas/City"}}},"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."}}},"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"]}}}} ``` ## The RetailStore object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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}}},"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."}}},"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"}}}}}} ``` ## The RetailStoreSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}}}} ``` ## The RetailStoreSerializerDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"RetailStoreSerializerDetailed":{"allOf":[{"$ref":"#/components/schemas/RetailStoreSerializer"}],"properties":{"township":{"$ref":"#/components/schemas/TownshipDetailed"},"district":{"$ref":"#/components/schemas/District"}}},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"TownshipDetailed":{"allOf":[{"$ref":"#/components/schemas/Township"}],"properties":{"city":{"$ref":"#/components/schemas/City"}}},"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."}}},"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"]},"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"]}}}} ``` ## The RetailStoreDistrictsSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"RetailStoreDistrictsSerializer":{"type":"object","description":"A request to add or remove districts from a retail store.","properties":{"districts":{"type":"array","items":{"type":"integer"}}},"required":["districts"]}}}} ``` ## The ContentType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The Mapping object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Mapping":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Mapping ID"},"mapping_type":{"type":"string","description":"Type of the mapping.","enum":["attribute","attribute_set","attribute_value"]},"input_kwargs":{"type":"object","description":"Input arguments in JSON format"},"output_kwargs":{"type":"object","description":"Output arguments in JSON format"},"priority":{"type":"integer","description":"Priority of the mapping"},"mapping_key":{"type":"string","description":"Key of the mapping"},"created_date":{"type":"string","format":"date-time","description":"The date and time when the mapping object was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the mapping object was last modified"}}}}}} ``` ## The Application object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","maxLength":100},"application_type":{"type":"string","enum":["oms","instore","commerce","zero","live-commerce","live-commerce-landing-page","omnitron-frontend","sales-channel","bi-tool","integrator","ui-protocol","invoicer","extension","seller_center_be","seller_center_fe","cargo_extension","b2b_extension","integration"],"description":"Enum value for the type of application"},"config":{"type":"object","description":"Configuration for the application in JSON format. Config contains various properties, including `visible_type` Used to set the application visibility as `fullpage`, `plugin`, or `empty`. This is relevant for `ui-protocol` applications. Default value is `empty` if not provided.","nullable":true,"additionalProperties":true},"is_active":{"type":"boolean","default":true},"remote_object_id":{"type":"integer","nullable":true},"created_by":{"type":"integer","nullable":true,"description":"ID of the user who created the application"},"is_visible":{"type":"boolean","description":"Default value is `False`. `is_visible` determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to `True`.","default":false},"is_proxy_available":{"type":"boolean","description":"Specifies whether requests to the `api/v1/app_proxy/` endpoint should be forwarded to the related application via proxy. Default value is `False`. If set to `False`, no proxy forwarding is done, and users receive an HTTP 404. If `is_proxy_available=True`, requests are forwarded to the application's `web_url` in the config.","default":false},"related_application_id":{"type":"string","nullable":true,"maxLength":255,"description":"The `related_application_id` field stores the associated extension ID from ACC for the Omnitron application. It can be filtered using the `related_application_id__iexact` parameter, and it accepts up to 255 characters."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the application was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the application was last modified"}},"required":["name","application_type","is_active","is_visible","is_proxy_available"]}}}} ``` ## The ApplicationPermission object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ApplicationPermission":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key for the application permission."},"name":{"type":"string","description":"The name of the application permission."},"path":{"type":"string","description":"The path of the application permission."},"label":{"type":"string","description":"The label of the application permission."},"parent":{"type":"integer","description":"Unique identifier for the parent application permission."},"application":{"type":"integer","description":"Unique identifier for the related application."}}},"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."}}}}}} ``` ## The ApplicationPermissionCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ApplicationPermissionCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the application permission."},"path":{"type":"string","description":"The path of the application permission."},"label":{"type":"string","description":"The label of the application permission."},"parent":{"type":"integer","description":"Unique identifier for the parent application permission."},"application":{"type":"integer","description":"Unique identifier for the related application."}}}}}} ``` ## The ApplicationPermissionUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ApplicationPermissionUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the application permission."},"path":{"type":"string","description":"The path of the application permission."},"label":{"type":"string","description":"The label of the application permission."},"parent":{"type":"integer","description":"Unique identifier for the parent application permission."},"application":{"type":"integer","description":"Unique identifier for the related application."}}}}}} ``` ## The ApplicationPermissionDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ApplicationPermissionDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key for the application permission."},"name":{"type":"string","description":"The name of the application permission."},"path":{"type":"string","description":"The path of the application permission."},"label":{"type":"string","description":"The label of the application permission."},"parent":{"$ref":"#/components/schemas/ApplicationPermission"},"application":{"type":"integer","description":"Unique identifier for the related application."}}},"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."}}},"ApplicationPermission":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key for the application permission."},"name":{"type":"string","description":"The name of the application permission."},"path":{"type":"string","description":"The path of the application permission."},"label":{"type":"string","description":"The label of the application permission."},"parent":{"type":"integer","description":"Unique identifier for the parent application permission."},"application":{"type":"integer","description":"Unique identifier for the related application."}}}}}} ``` ## The ApplicationPermissionChild object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ApplicationPermissionChild":{"type":"object","allOf":[{"$ref":"#/components/schemas/ApplicationPermission"}],"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPermission"},"description":"List of child application permissions."}}},"ApplicationPermission":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key for the application permission."},"name":{"type":"string","description":"The name of the application permission."},"path":{"type":"string","description":"The path of the application permission."},"label":{"type":"string","description":"The label of the application permission."},"parent":{"type":"integer","description":"Unique identifier for the parent application permission."},"application":{"type":"integer","description":"Unique identifier for the related application."}}},"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."}}}}}} ``` ## The PayOnDeliveryTransaction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}},"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]},"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]}}}} ``` ## The OrderItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."}}},"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."}}},"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"},"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"]},"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"]}}}} ``` ## The OrderItemDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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}}},"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."}}},"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."}}},"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"]},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"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"},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]}}}} ``` ## The SubOrderItemExtraDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SubOrderItemExtraDetailed":{"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},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}}}},"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."}}},"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."}}},"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"]},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"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"},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"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"}}}}}} ``` ## The OrderItemEasyReturnLocation object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderItemEasyReturnLocation":{"type":"object","properties":{"source":{"type":"string","description":"The name of the source."},"origin_address":{"type":"string","nullable":true,"description":"The original address information."},"origin_address_id":{"type":"string","nullable":true,"description":"The ID of the original address."},"package_number":{"type":"string","nullable":true,"description":"The package number."}},"required":["source"]}}}} ``` ## The OrderItemSplit object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderItemSplit":{"type":"object","properties":{"waiting_quantity":{"type":"integer","minimum":1,"description":"The quantity of items waiting to be split. Must be at least 1."}},"required":["waiting_quantity"]}}}} ``` ## The ReduceWeight object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ReduceWeight":{"type":"object","properties":{"new_weight":{"type":"number","format":"decimal","description":"The new weight value for the order item."}},"required":["new_weight"]}}}} ``` ## The ReplaceProduct object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ReplaceProduct":{"type":"object","properties":{"new_product_sku":{"type":"string","description":"The sku of the new product to replace the current one."}},"required":["new_product_sku"]}}}} ``` ## The OrderItemExtraFieldUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderItemExtraFieldUpdate":{"type":"object","properties":{"extra_field":{"type":"object","description":"A JSON object containing extra fields for the order item."}},"required":["extra_field"]}}}} ``` ## The InvoiceItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"InvoiceItem":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice item"},"invoice":{"type":"integer","description":"Related invoice ID"},"order_item":{"type":"integer","description":"Related order item ID"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the invoice item"},"tax_amount":{"type":"number","format":"decimal","description":"Tax amount of the invoice item"},"discount_rate":{"type":"number","format":"decimal","description":"Discount rate of the invoice item"},"discount_amount":{"type":"number","format":"decimal","description":"Discount amount of the invoice item"},"total_amount":{"type":"number","format":"decimal","description":"Total amount of the invoice item"},"net_amount":{"type":"number","format":"decimal","description":"Net amount of the invoice item"},"related_invoice_item":{"type":"integer","description":"Related invoice item ID"}}}}}} ``` ## The InvoiceItemHyperlinked object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"InvoiceItemHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice item"},"pk":{"type":"integer","description":"Primary key of the invoice item"},"invoice":{"type":"string","format":"uuid","description":"Related invoice ID"},"order_item":{"type":"string","format":"uuid","description":"Related order item ID"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the invoice item"},"tax_amount":{"type":"number","format":"decimal","description":"Tax amount of the invoice item"},"discount_rate":{"type":"number","format":"decimal","description":"Discount rate of the invoice item"},"discount_amount":{"type":"number","format":"decimal","description":"Discount amount of the invoice item"},"total_amount":{"type":"number","format":"decimal","description":"Total amount of the invoice item"},"net_amount":{"type":"number","format":"decimal","description":"Net amount of the invoice item"},"related_invoice_item":{"type":"string","format":"uuid","description":"Related invoice item ID"}}}}}} ``` ## The InvoiceType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"InvoiceType":{"type":"string","enum":["purchase","refund"]}}}} ``` ## The Invoice object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Invoice":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"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"]},"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"}}}}}} ``` ## The InvoiceDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"InvoiceDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"},"invoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"paymentinvoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/PaymentInvoiceItem"}},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"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"]},"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"}}},"Invoice":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/Invoice"}}},"InvoiceItem":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the invoice item"},"invoice":{"type":"integer","description":"Related invoice ID"},"order_item":{"type":"integer","description":"Related order item ID"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the invoice item"},"tax_amount":{"type":"number","format":"decimal","description":"Tax amount of the invoice item"},"discount_rate":{"type":"number","format":"decimal","description":"Discount rate of the invoice item"},"discount_amount":{"type":"number","format":"decimal","description":"Discount amount of the invoice item"},"total_amount":{"type":"number","format":"decimal","description":"Total amount of the invoice item"},"net_amount":{"type":"number","format":"decimal","description":"Net amount of the invoice item"},"related_invoice_item":{"type":"integer","description":"Related invoice item ID"}}},"PaymentInvoiceItem":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the payment invoice item"},"invoice":{"type":"integer","description":"Related invoice ID"},"order_transaction":{"type":"integer","description":"Related order transaction ID"},"instant_amount":{"type":"number","format":"decimal","description":"Instant amount of the payment invoice item"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was created"}}}}}} ``` ## The InvoiceHyperlinked object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"InvoiceHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"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"]},"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"}}}}}} ``` ## The InvoiceDetailedHyperlinked object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"InvoiceDetailedHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"},"invoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemHyperlinked"}},"paymentinvoiceitem_set":{"type":"array","items":{"$ref":"#/components/schemas/PaymentInvoiceItemHyperlinked"}}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"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"]},"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"}}},"InvoiceHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}},"InvoiceItemHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice item"},"pk":{"type":"integer","description":"Primary key of the invoice item"},"invoice":{"type":"string","format":"uuid","description":"Related invoice ID"},"order_item":{"type":"string","format":"uuid","description":"Related order item ID"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the invoice item"},"tax_amount":{"type":"number","format":"decimal","description":"Tax amount of the invoice item"},"discount_rate":{"type":"number","format":"decimal","description":"Discount rate of the invoice item"},"discount_amount":{"type":"number","format":"decimal","description":"Discount amount of the invoice item"},"total_amount":{"type":"number","format":"decimal","description":"Total amount of the invoice item"},"net_amount":{"type":"number","format":"decimal","description":"Net amount of the invoice item"},"related_invoice_item":{"type":"string","format":"uuid","description":"Related invoice item ID"}}},"PaymentInvoiceItemHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the payment invoice item"},"pk":{"type":"integer","description":"Primary key of the payment invoice item"},"invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"order_transaction":{"$ref":"#/components/schemas/OrderTransactionHyperlinked"},"instant_amount":{"type":"number","format":"decimal","description":"Instant amount of the payment invoice item"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was created"}}},"OrderTransactionHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"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."},"OrderTransactionType":{"type":"string","enum":["purchase","refund"]},"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"]},"Transaction":{"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":{"type":"string","description":"Related point of sale ID"},"main_pos":{"type":"string","description":"Main point of sale ID"},"order":{"type":"integer","description":"ID of the related 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"}}},"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."}}},"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"]},"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"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"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"]},"OrderTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"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"}}},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}},"RefundPaymentPlan":{"allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the refund payment plan"},"cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"transaction_type":{"$ref":"#/components/schemas/PaymentType"},"refund_amount":{"type":"number","format":"decimal","description":"Refund amount of the refund payment plan"},"retry_count":{"type":"integer","description":"Retry count of the refund payment plan"},"status":{"$ref":"#/components/schemas/RefundPaymentPlanStatus"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was created"}}},"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."},"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"},"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"}}},"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"}}},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"}}}} ``` ## The CancellationRequestImage object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationRequestImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation request image"},"cancellation_request":{"type":"integer","description":"ID of the associated cancellation request"},"image":{"type":"string","format":"uri","description":"URL of the uploaded image"},"description":{"type":"string","description":"Description of the image"},"attributes":{"type":"object","description":"Additional attributes for the image"},"uploaded_by":{"type":"integer","description":"ID of the user who uploaded the image"}}},"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."}}}}}} ``` ## The Order object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The VendorOrderWithDataSource object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."}}}}}} ``` ## The OrderDetailedList object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderSplit object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}}}}} ``` ## The OrderSplitPackages object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}}}}} ``` ## The OrderGatewayPosHistory object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"}}}}}}}} ``` ## The CaptureOrder object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CaptureOrder":{"properties":{"force_refund":{"type":"boolean"}}}}}} ``` ## The BulkReplaceProductItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BulkReplaceProductItem":{"properties":{"order_item":{"type":"integer","description":"Order item ID for product replacement"},"new_product_sku":{"type":"string","description":"New product SKU for replacement"}}}}}} ``` ## The BulkReplaceProduct object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BulkReduceWeightItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BulkReduceWeight object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BulkReplaceProductAndReduceWeightItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The BulkReplaceProductAndReduceWeight object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The CargoCompany object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}},"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"]}}}} ``` ## The OrderDataSource object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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."}}}}}} ``` ## The OrderBillingAddress object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderShippingAddress object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderStatusChange object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The OrderCreateMapping object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderCreateMappingResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderCreateMappingResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/OrderCreateMapping"},{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Unique identifier for the mapping."}}},"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"]},"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."}}}}}} ``` ## The OrderRefund object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderRefund":{"type":"object","properties":{"is_refund_success":{"type":"boolean","description":"Indicates whether the refund was successful."}},"required":["is_refund_success"]}}}} ``` ## The OrderCancel object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}}}}} ``` ## The OrderCancelStatusUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The Transaction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Transaction":{"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":{"type":"string","description":"Related point of sale ID"},"main_pos":{"type":"string","description":"Main point of sale ID"},"order":{"type":"integer","description":"ID of the related 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"}}},"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."}}},"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"]},"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"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]}}}} ``` ## The TransactionDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}},"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."},"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"}}},"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"]},"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"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]}}}} ``` ## The OrderTransactionType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderTransactionType":{"type":"string","enum":["purchase","refund"]}}}} ``` ## The OrderTransaction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"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."},"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"}}},"OrderTransactionType":{"type":"string","enum":["purchase","refund"]},"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"]},"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"]},"Transaction":{"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":{"type":"string","description":"Related point of sale ID"},"main_pos":{"type":"string","description":"Main point of sale ID"},"order":{"type":"integer","description":"ID of the related 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"}}},"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."}}},"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"]},"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"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"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"]},"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"}}},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}},"RefundPaymentPlan":{"allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the refund payment plan"},"cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"transaction_type":{"$ref":"#/components/schemas/PaymentType"},"refund_amount":{"type":"number","format":"decimal","description":"Refund amount of the refund payment plan"},"retry_count":{"type":"integer","description":"Retry count of the refund payment plan"},"status":{"$ref":"#/components/schemas/RefundPaymentPlanStatus"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was created"}}},"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."},"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"},"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"}}},"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"}}},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"}}}} ``` ## The OrderTransactionHyperlinked object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderTransactionHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"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."},"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"}}},"OrderTransactionType":{"type":"string","enum":["purchase","refund"]},"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"]},"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"]},"Transaction":{"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":{"type":"string","description":"Related point of sale ID"},"main_pos":{"type":"string","description":"Main point of sale ID"},"order":{"type":"integer","description":"ID of the related 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"}}},"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."}}},"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"]},"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"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"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"]},"OrderTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"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"}}},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}},"RefundPaymentPlan":{"allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the refund payment plan"},"cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"transaction_type":{"$ref":"#/components/schemas/PaymentType"},"refund_amount":{"type":"number","format":"decimal","description":"Refund amount of the refund payment plan"},"retry_count":{"type":"integer","description":"Retry count of the refund payment plan"},"status":{"$ref":"#/components/schemas/RefundPaymentPlanStatus"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was created"}}},"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."},"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"},"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"}}},"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"}}},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"}}}} ``` ## The CancellationReason object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The CancellationReasonCreateUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationReasonCreateUpdate":{"type":"object","description":"Input schema for creating or updating a cancellation reason","properties":{"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"}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The ReservedStockInfo object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ReservedStockInfo":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"order_item":{"type":"integer","description":"Related order item ID"},"product_stock":{"type":"integer","description":"Related product stock ID"},"is_active":{"type":"boolean","description":"Whether the reserved stock info is active"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified date"}}},"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."}}}}}} ``` ## The RefundPaymentPlanStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"}}}} ``` ## The RefundPaymentPlan object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"RefundPaymentPlan":{"allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the refund payment plan"},"cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"transaction_type":{"$ref":"#/components/schemas/PaymentType"},"refund_amount":{"type":"number","format":"decimal","description":"Refund amount of the refund payment plan"},"retry_count":{"type":"integer","description":"Retry count of the refund payment plan"},"status":{"$ref":"#/components/schemas/RefundPaymentPlanStatus"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was created"}}},"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."}}},"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"}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}},"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."},"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"}}}} ``` ## The PaymentInvoiceItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"PaymentInvoiceItem":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the payment invoice item"},"invoice":{"type":"integer","description":"Related invoice ID"},"order_transaction":{"type":"integer","description":"Related order transaction ID"},"instant_amount":{"type":"number","format":"decimal","description":"Instant amount of the payment invoice item"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was created"}}}}}} ``` ## The PaymentInvoiceItemHyperlinked object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"PaymentInvoiceItemHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the payment invoice item"},"pk":{"type":"integer","description":"Primary key of the payment invoice item"},"invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"order_transaction":{"$ref":"#/components/schemas/OrderTransactionHyperlinked"},"instant_amount":{"type":"number","format":"decimal","description":"Instant amount of the payment invoice item"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the payment invoice item was created"}}},"InvoiceHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the invoice"},"pk":{"type":"integer","description":"Primary key of the invoice"},"number":{"type":"string","description":"Number of the invoice"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType"},"order":{"$ref":"#/components/schemas/Order"},"channel":{"$ref":"#/components/schemas/Channel"},"related_invoice":{"$ref":"#/components/schemas/InvoiceHyperlinked"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the invoice"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the invoice was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the invoice was created"}}},"InvoiceType":{"type":"string","enum":["purchase","refund"]},"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"]},"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"}}},"OrderTransactionHyperlinked":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"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."},"OrderTransactionType":{"type":"string","enum":["purchase","refund"]},"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"]},"Transaction":{"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":{"type":"string","description":"Related point of sale ID"},"main_pos":{"type":"string","description":"Main point of sale ID"},"order":{"type":"integer","description":"ID of the related 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"}}},"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."}}},"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"]},"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"]},"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]},"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"]},"OrderTransaction":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the order transaction"},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the order transaction"},"payment_option":{"$ref":"#/components/schemas/PaymentOption"},"amount":{"type":"number","format":"decimal","description":"Amount of the order transaction"},"transaction_type":{"$ref":"#/components/schemas/OrderTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"transaction_content_type":{"$ref":"#/components/schemas/ContentType"},"transaction_object_id":{"type":"integer","description":"ID of the related transaction object"},"transaction":{"$ref":"#/components/schemas/Transaction"},"customer":{"$ref":"#/components/schemas/Customer"},"related_ordertransaction":{"$ref":"#/components/schemas/OrderTransaction"},"related_cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"refund_payment_plan":{"$ref":"#/components/schemas/RefundPaymentPlan"},"mapping":{"$ref":"#/components/schemas/IntegrationMapping"},"integration":{"$ref":"#/components/schemas/IntegrationRelation"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the order transaction was created"}}},"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"}}},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}},"RefundPaymentPlan":{"allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the refund payment plan"},"cancellation_plan":{"$ref":"#/components/schemas/CancellationPlan"},"transaction_type":{"$ref":"#/components/schemas/PaymentType"},"refund_amount":{"type":"number","format":"decimal","description":"Refund amount of the refund payment plan"},"retry_count":{"type":"integer","description":"Retry count of the refund payment plan"},"status":{"$ref":"#/components/schemas/RefundPaymentPlanStatus"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was last modified"},"created_date":{"type":"string","format":"date-time","description":"Date and time the refund payment plan was created"}}},"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."},"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"},"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"}}},"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"}}},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"}}}} ``` ## The ShippingOptionGroup object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."}}}}}} ``` ## The BexTransaction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BexTransaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"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":{"type":"integer","description":"ID of the associated point of sale"},"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"}}},"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."}}},"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]}}}} ``` ## The BexTransactionDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."},"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"}}}}}} ``` ## The DiscountItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}},"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"]}}}} ``` ## The CargoCompanyCreateUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CargoCompanyCreateUpdate":{"type":"object","description":"Input schema for creating or updating a cargo company record.","properties":{"name":{"type":"string","maxLength":64,"description":"Name of the cargo company."},"erp_code":{"type":"string","maxLength":64,"description":"ERP code used for identifying the cargo company in external systems."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","description":"Enum value indicating the shipping company type."}},"required":["name","erp_code","shipping_company"]},"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"]}}}} ``` ## The Promotion object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"Promotion":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the promotion"},"name":{"type":"string","description":"Name of the promotion"},"slug":{"type":"string","description":"Slug of the promotion"},"integration":{"type":"integer","description":"Foreign key to IntegrationAction model"},"created_date":{"type":"string","format":"date-time","description":"Date and time the promotion was created"},"modified_date":{"type":"string","format":"date-time","description":"Date and time the promotion was last modified"}}},"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."}}}}}} ``` ## The CaptureOrderItemSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CaptureOrderItemSerializer":{"properties":{"pk":{"type":"integer","description":"Order Item ID"},"attributes":{"type":"object","description":"Order item attributes"}}}}}} ``` ## The CaptureOrderSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CaptureOrderSerializer":{"properties":{"order":{"type":"string","description":"Order Number"},"order_items":{"type":"array","description":"List of order items","items":{"$ref":"#/components/schemas/CaptureOrderItemSerializer"}}}},"CaptureOrderItemSerializer":{"properties":{"pk":{"type":"integer","description":"Order Item ID"},"attributes":{"type":"object","description":"Order item attributes"}}}}}} ``` ## The CancellationPlanOrderItem object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationPlanOrderItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key"},"order_item":{"$ref":"#/components/schemas/OrderItem"},"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"}}},"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."}}},"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."}}},"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"},"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"]},"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"]},"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"]}}}} ``` ## The CancellationPlanOrderItemDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"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"]},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"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"},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The CashRegisterTransaction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The B2BTransaction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The CancellationPlan object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}}}}} ``` ## The CancellationPlanCreatePaymentPlan object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationPlanCreatePaymentPlan":{"type":"object","properties":{"payment_plan":{"type":"array","items":{"type":"object","properties":{"transaction_type":{"type":"string","description":"Type of transaction"},"order_items":{"type":"array","items":{"type":"integer"},"description":"List of order item IDs"}},"required":["transaction_type","order_items"]}}},"required":["payment_plan"]}}}} ``` ## The CancellationEasyReturn object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationEasyReturn":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation easy return","readOnly":true},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"code":{"type":"string","description":"Code for the cancellation easy return","nullable":true},"start_date":{"type":"string","format":"date-time","description":"Start date of the cancellation easy return","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the cancellation easy return","nullable":true},"max_count":{"type":"integer","description":"Maximum number of returns allowed","nullable":true},"status":{"$ref":"#/components/schemas/CancellationEasyReturnStatus"},"raw_request":{"type":"string","description":"Raw request data for the cancellation easy return","nullable":true},"raw_response":{"type":"string","description":"Raw response data for the cancellation easy return","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for return","nullable":true},"tracking_url":{"type":"string","format":"uri","maxLength":4096,"description":"Tracking URL for return, if available","nullable":true},"pickup_date":{"type":"object","nullable":false,"default":{},"description":"JSON field to store pickup date-related data"}}},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"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"]},"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]}}}} ``` ## The OrderComment object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderComment":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the order comment","readOnly":true},"comment":{"type":"string","description":"Comment of the order comment"},"order":{"type":"integer","description":"ID of the order"},"created_by":{"type":"integer","description":"ID of the created by user","readOnly":true},"created_date":{"type":"string","format":"date-time","description":"Date and time the order comment was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Date and time the order comment was last modified","readOnly":true}}},"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."}}}}}} ``` ## The ReadOnlyRefundPaymentPlan object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ReadOnlyRefundPaymentPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"cancellation_plan":{"type":"integer","description":"ID of the associated cancellation plan"},"transaction_type":{"$ref":"#/components/schemas/PaymentType"},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the payment plan"},"retry_count":{"type":"integer","description":"Number of retry attempts for the payment plan"},"status":{"$ref":"#/components/schemas/RefundPaymentPlanStatus"}}},"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."}}},"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."},"RefundPaymentPlanStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Status of the refund payment plan"}}}} ``` ## The BenefitApplicant object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."}}}}}} ``` ## The CancellationRequest object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Cancellation Request ID"},"order_item":{"type":"integer","description":"Related order item ID"},"reason":{"type":"integer","description":"Related cancellation reason ID"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"status":{"$ref":"#/components/schemas/CancellationRequestStatus"},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"easy_return":{"type":"object","$ref":"#/components/schemas/CancellationEasyReturn","nullable":true},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true},"fully_refund_as_loyalty_money":{"type":"boolean","description":"Flag to indicate if the refund should be processed as loyalty money","default":false}},"required":["id","order_item","reason","cancellation_type","status","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"CancellationEasyReturn":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation easy return","readOnly":true},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"code":{"type":"string","description":"Code for the cancellation easy return","nullable":true},"start_date":{"type":"string","format":"date-time","description":"Start date of the cancellation easy return","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the cancellation easy return","nullable":true},"max_count":{"type":"integer","description":"Maximum number of returns allowed","nullable":true},"status":{"$ref":"#/components/schemas/CancellationEasyReturnStatus"},"raw_request":{"type":"string","description":"Raw request data for the cancellation easy return","nullable":true},"raw_response":{"type":"string","description":"Raw response data for the cancellation easy return","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for return","nullable":true},"tracking_url":{"type":"string","format":"uri","maxLength":4096,"description":"Tracking URL for return, if available","nullable":true},"pickup_date":{"type":"object","nullable":false,"default":{},"description":"JSON field to store pickup date-related data"}}},"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"]},"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]}}}} ``` ## The CancellationRequestDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationRequestDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Cancellation Request ID"},"order_item":{"type":"object","$ref":"#/components/schemas/OrderItemDetailed"},"reason":{"type":"object","$ref":"#/components/schemas/CancellationReason"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"status":{"$ref":"#/components/schemas/CancellationRequestStatus"},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"easy_return":{"type":"object","$ref":"#/components/schemas/CancellationEasyReturn","nullable":true},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true},"fully_refund_as_loyalty_money":{"type":"boolean","description":"Flag to indicate if the refund should be processed as loyalty money","default":false},"channel":{"type":"object","$ref":"#/components/schemas/Channel"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"}}},"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}}},"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."}}},"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."}}},"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"]},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"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"},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"CancellationEasyReturn":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation easy return","readOnly":true},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"code":{"type":"string","description":"Code for the cancellation easy return","nullable":true},"start_date":{"type":"string","format":"date-time","description":"Start date of the cancellation easy return","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the cancellation easy return","nullable":true},"max_count":{"type":"integer","description":"Maximum number of returns allowed","nullable":true},"status":{"$ref":"#/components/schemas/CancellationEasyReturnStatus"},"raw_request":{"type":"string","description":"Raw request data for the cancellation easy return","nullable":true},"raw_response":{"type":"string","description":"Raw response data for the cancellation easy return","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for return","nullable":true},"tracking_url":{"type":"string","format":"uri","maxLength":4096,"description":"Tracking URL for return, if available","nullable":true},"pickup_date":{"type":"object","nullable":false,"default":{},"description":"JSON field to store pickup date-related data"}}},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]},"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"]}}}} ``` ## The CancellationRequestDetailedExport object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationRequestDetailedExport":{"type":"object","description":"Detailed cancellation request data optimized for export purposes. Used when export_format query parameter is provided. Returns JSON with a different field set than the standard detailed view.","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Cancellation Request ID"},"order_item":{"type":"object","$ref":"#/components/schemas/OrderItemDetailed","description":"Detailed order item information"},"channel":{"type":"object","$ref":"#/components/schemas/Channel","description":"Channel information"},"reason":{"type":"object","$ref":"#/components/schemas/CancellationReason","description":"Cancellation reason"},"status":{"$ref":"#/components/schemas/CancellationRequestStatus","description":"Current status of the cancellation request"},"created_date":{"type":"string","format":"date-time","description":"Date when the cancellation request was created"},"customer":{"type":"object","$ref":"#/components/schemas/Customer","description":"Customer information"},"last_updated_by":{"type":"string","nullable":true,"description":"Username of the user who last updated the cancellation request"},"cancellation_type":{"$ref":"#/components/schemas/CancellationType","description":"Type of cancellation (refund, exchange, etc.)"},"easy_return":{"type":"object","$ref":"#/components/schemas/CancellationEasyReturn","nullable":true,"description":"Easy return information if applicable"},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"iban":{"type":"string","description":"IBAN for refund","nullable":true}}},"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}}},"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."}}},"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."}}},"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"]},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"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"},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"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"}}},"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"]},"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"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"]},"CancellationEasyReturn":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation easy return","readOnly":true},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"code":{"type":"string","description":"Code for the cancellation easy return","nullable":true},"start_date":{"type":"string","format":"date-time","description":"Start date of the cancellation easy return","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the cancellation easy return","nullable":true},"max_count":{"type":"integer","description":"Maximum number of returns allowed","nullable":true},"status":{"$ref":"#/components/schemas/CancellationEasyReturnStatus"},"raw_request":{"type":"string","description":"Raw request data for the cancellation easy return","nullable":true},"raw_response":{"type":"string","description":"Raw response data for the cancellation easy return","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for return","nullable":true},"tracking_url":{"type":"string","format":"uri","maxLength":4096,"description":"Tracking URL for return, if available","nullable":true},"pickup_date":{"type":"object","nullable":false,"default":{},"description":"JSON field to store pickup date-related data"}}},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]}}}} ``` ## The CancellationRequestCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationRequestCreate":{"type":"object","required":["order_item","reason","cancellation_type"],"properties":{"order_item":{"type":"integer","description":"Related order item ID"},"reason":{"type":"integer","description":"Related cancellation reason ID"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The CancellationRequestUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationRequestUpdate":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/CancellationRequestStatus"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true},"fully_refund_as_loyalty_money":{"type":"boolean","description":"Flag to indicate if the refund should be processed as loyalty money","default":false},"reason":{"type":"integer","description":"Related cancellation reason ID"},"order_item":{"type":"integer","description":"Related order item ID"}}},"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The OrderAddressChangingRequest object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderAddressChangingRequest":{"type":"object","properties":{"channel_id":{"type":"integer","description":"The ID of the sales channel where the order originates."},"order":{"type":"integer","description":"Remote ID of the order to update."},"address":{"$ref":"#/components/schemas/AddressInput"},"order_address_types":{"type":"array","items":{"$ref":"#/components/schemas/OrderAddressType"}}},"required":["channel_id","order","address","order_address_types"]},"AddressInput":{"type":"object","properties":{"pk":{"type":"integer","description":"Remote ID of the address."},"first_name":{"type":"string","description":"First name of the person associated with the address."},"last_name":{"type":"string","description":"Last name of the person associated with the address."},"email":{"type":"string","description":"Email address of the person associated with the address."},"phone_number":{"type":"string","description":"Phone number of the person associated with the address."},"title":{"type":"string","description":"Title or designation for the address (e.g., Home, Work)."},"line":{"type":"string","description":"Street address line."},"postcode":{"type":"string","description":"Postal code for the address."},"notes":{"type":"string","description":"Additional notes or instructions for the address."},"country":{"type":"integer","description":"Remote ID of the country."},"city":{"type":"integer","description":"Remote ID of the city."},"township":{"type":"integer","description":"Remote ID of the township."},"district":{"type":"integer","description":"Remote ID of the district."},"retail_store":{"type":"integer","nullable":true,"description":"Remote ID of the retail store, if applicable."},"company_name":{"type":"string","description":"Company name associated with the address, if applicable."},"tax_no":{"type":"string","description":"Tax number associated with the address, if applicable."},"tax_office":{"type":"string","description":"Tax office associated with the address, if applicable."},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the entity is an e-bill taxpayer."},"address_type":{"$ref":"#/components/schemas/AddressType"},"identity_number":{"type":"string","nullable":true,"description":"Identity number associated with the address, if applicable."},"extra_field":{"type":"object","additionalProperties":true,"description":"Optional dictionary for additional address metadata."}},"required":["pk","first_name","last_name","email","phone_number","title","line","postcode","notes","country","city","township","district","company_name","tax_no","tax_office","e_bill_taxpayer","address_type"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"OrderAddressType":{"type":"string","description":"Type of order address","enum":["shipping_address","billing_address"]}}}} ``` ## The AddressInput object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"AddressInput":{"type":"object","properties":{"pk":{"type":"integer","description":"Remote ID of the address."},"first_name":{"type":"string","description":"First name of the person associated with the address."},"last_name":{"type":"string","description":"Last name of the person associated with the address."},"email":{"type":"string","description":"Email address of the person associated with the address."},"phone_number":{"type":"string","description":"Phone number of the person associated with the address."},"title":{"type":"string","description":"Title or designation for the address (e.g., Home, Work)."},"line":{"type":"string","description":"Street address line."},"postcode":{"type":"string","description":"Postal code for the address."},"notes":{"type":"string","description":"Additional notes or instructions for the address."},"country":{"type":"integer","description":"Remote ID of the country."},"city":{"type":"integer","description":"Remote ID of the city."},"township":{"type":"integer","description":"Remote ID of the township."},"district":{"type":"integer","description":"Remote ID of the district."},"retail_store":{"type":"integer","nullable":true,"description":"Remote ID of the retail store, if applicable."},"company_name":{"type":"string","description":"Company name associated with the address, if applicable."},"tax_no":{"type":"string","description":"Tax number associated with the address, if applicable."},"tax_office":{"type":"string","description":"Tax office associated with the address, if applicable."},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the entity is an e-bill taxpayer."},"address_type":{"$ref":"#/components/schemas/AddressType"},"identity_number":{"type":"string","nullable":true,"description":"Identity number associated with the address, if applicable."},"extra_field":{"type":"object","additionalProperties":true,"description":"Optional dictionary for additional address metadata."}},"required":["pk","first_name","last_name","email","phone_number","title","line","postcode","notes","country","city","township","district","company_name","tax_no","tax_office","e_bill_taxpayer","address_type"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}}}} ``` ## The OrderExternalStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderShippingInfo object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderShippingInfo":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"order":{"type":"integer","description":"Associated Order value"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"send_request":{"type":"string","description":"Request information","nullable":true},"send_response":{"type":"object","description":"Response information"},"is_send":{"type":"boolean","description":"ERP's is_send condition"},"cargo_label":{"type":"string","format":"uri","nullable":true,"description":"Cargo label information (URL)"},"shipping_option_group":{"type":"integer","description":"Associated Shipping Option Group value","nullable":true}}},"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."}}},"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"]}}}} ``` ## The OrderShippingInfoGet object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderShippingInfoGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"order":{"type":"integer","description":"Associated Order value"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"send_request":{"type":"string","description":"Request information","nullable":true},"send_response":{"type":"object","description":"Response information"},"is_send":{"type":"boolean","description":"ERP's is_send condition"},"cargo_label":{"type":"string","format":"uri","nullable":true,"description":"Cargo label information (URL)"},"shipping_option_group":{"type":"integer","description":"Associated Shipping Option Group value","nullable":true},"order_number":{"type":"string","description":"Order number"}}},"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."}}},"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"]}}}} ``` ## The FundsTransferTransactionReadOnly object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}},"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"]},"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"]}}}} ``` ## The ErrorReport object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ErrorReport":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Error report ID"},"action_content_type":{"type":"integer","description":"Content type ID for action"},"action_object_id":{"type":"integer","description":"Object ID for action"},"action":{"type":"object","description":"Generic foreign key relation for action","additionalProperties":true},"target_content_type":{"type":"integer","nullable":true,"description":"Content type ID for target"},"target_object_id":{"type":"string","maxLength":255,"nullable":true,"description":"Object ID for target"},"target":{"type":"object","nullable":true,"description":"Generic foreign key relation for target","additionalProperties":true},"obj_modified_date":{"type":"string","format":"date-time","description":"Object modification date"},"error_code":{"type":"string","maxLength":128,"description":"Error code"},"error_desc":{"type":"string","description":"Error description"},"is_ok":{"type":"boolean","default":false,"description":"Status flag"},"raw_request":{"type":"string","nullable":true,"description":"Raw request data"},"raw_response":{"type":"string","nullable":true,"description":"Raw response data"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Creation timestamp"},"updated_date":{"type":"string","format":"date-time","readOnly":true,"description":"Last update timestamp"}},"required":["action_content_type","action_object_id","obj_modified_date","error_code","error_desc"]}}}} ``` ## The MarketPlaceAttributeSetConfig object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSetConfig":{"type":"object","description":"Represents a configuration linking a marketplace attribute set to a target object (like a category node) via a generic foreign key.","properties":{"pk":{"type":"integer","description":"Primary key of the configuration instance."},"attribute_set":{"type":"integer","description":"ID of the related MarketPlaceAttributeSet."},"object_id":{"type":"integer","description":"ID of the target object this configuration applies to (e.g., a CategoryNode ID)."},"content_type":{"type":"string","description":"The model name of the target object's content type (e.g., 'categorynode')."},"created_date":{"type":"string","format":"date-time","description":"Timestamp of when the configuration was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp of the last modification."},"url":{"type":"string","format":"uri","nullable":true,"description":"Fully qualified URL of the resource (present only in hyperlinked serializers)."}}}}}} ``` ## The MarketPlaceAttributeSetConfigHyperlinked object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSetConfigHyperlinked":{"type":"object","description":"Represents a configuration linking a marketplace attribute set to a content object, with hyperlinks for related resources.","properties":{"pk":{"type":"integer","description":"Primary key of the configuration."},"url":{"type":"string","format":"uri","description":"Fully qualified URL to this configuration instance."},"attribute_set":{"type":"string","format":"uri","description":"Hyperlink to the related MarketPlaceAttributeSet instance."},"object_id":{"type":"integer","description":"ID of the content object associated with the configuration."},"content_type":{"type":"string","format":"uri","description":"Hyperlink to the ContentType resource for the associated object."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when this config was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when this config was last modified."}}}}}} ``` ## The MarketPlaceAttributeSetConfigCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSetConfigCreate":{"type":"object","description":"Input schema for creating or updating a MarketPlaceAttributeSetConfig instance.","properties":{"attribute_set":{"type":"integer","description":"ID of the MarketPlaceAttributeSet to associate with the content object."},"object_id":{"type":"integer","description":"ID of the target object to be linked to the attribute set."},"content_type":{"type":"string","description":"Model name of the content type for the target object (must be a valid `ContentType.model` value)."}},"required":["content_type"]}}}} ``` ## The SalesChannelCancellationRequestImage object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCancellationRequestImage":{"$ref":"#/components/schemas/CancellationRequestImage"},"CancellationRequestImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation request image"},"cancellation_request":{"type":"integer","description":"ID of the associated cancellation request"},"image":{"type":"string","format":"uri","description":"URL of the uploaded image"},"description":{"type":"string","description":"Description of the image"},"attributes":{"type":"object","description":"Additional attributes for the image"},"uploaded_by":{"type":"integer","description":"ID of the user who uploaded the image"}}},"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."}}}}}} ``` ## The CancellationReasonCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationReasonCreate":{"type":"object","description":"Schema for creating a new cancellation reason.","properties":{"cancellation_type":{"type":"string","enum":["cancel","refund"],"description":"Type of cancellation. Optional, defaults to `cancel`."},"extra_information_needed":{"type":"boolean","description":"Whether extra info is required."},"order":{"type":"integer","description":"Sorting order for UI display."},"subject":{"type":"string","description":"Short label of the cancellation reason."},"is_active":{"type":"boolean","description":"Whether this reason is active."},"send_to_remote":{"type":"boolean","description":"Whether this reason syncs to external systems."}},"required":["subject"]}}}} ``` ## The CancellationReasonUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationReasonUpdate":{"type":"object","description":"Schema for updating existing cancellation reason.","properties":{"cancellation_type":{"type":"string","enum":["cancel","refund"],"description":"Type of cancellation. Optional, defaults to `cancel`."},"extra_information_needed":{"type":"boolean","description":"Whether extra info is required."},"order":{"type":"integer","description":"Sorting order for UI display."},"subject":{"type":"string","description":"Short label of the cancellation reason."},"is_active":{"type":"boolean","description":"Whether this reason is active."},"send_to_remote":{"type":"boolean","description":"Whether this reason syncs to external systems."}}}}}} ``` ## The SalesChannelCargoCompany object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCargoCompany":{"$ref":"#/components/schemas/CargoCompany"},"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"}}},"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."}}},"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"]}}}} ``` ## The SalesChannelProductImage object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelProductImage":{"$ref":"#/components/schemas/ProductImage"},"ProductImage":{"type":"object","description":"Represents an image associated with a product, used for display in sales channels or internal listings.","properties":{"pk":{"type":"integer","description":"Unique identifier for the product image.","readOnly":true},"product":{"type":"integer","description":"ID of the associated product."},"source":{"type":"string","nullable":true,"description":"The source of the image (e.g., 'unified').","enum":["unified","integration","seller_center"]},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the image was last modified."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the image was created.","readOnly":true},"height":{"type":"integer","nullable":true,"description":"Height of the image in pixels."},"width":{"type":"integer","nullable":true,"description":"Width of the image in pixels."},"hash":{"type":"string","nullable":true,"description":"A hash of the image content used for deduplication or versioning."},"status":{"type":"string","description":"Status of the image (e.g., active). Read-only.","enum":["active","disabled"]},"is_active":{"type":"boolean","description":"Indicates whether the image is currently active and should be used."},"order":{"type":"integer","description":"Display order for the image among other images of the same product."},"object_id":{"type":"integer","description":"ID of the target object this configuration applies to."},"content_type":{"type":"string","description":"The model name of the target object's content type."}}}}}} ``` ## The MarketPlaceAttributeConfig object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeConfig":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the attribute configuration."},"attribute_set":{"type":"integer","description":"ID of the associated attribute set."},"attribute":{"type":"integer","description":"ID of the associated attribute."},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"ID of the locale-specific attribute schema."},"attribute_remote_id":{"type":"string","nullable":true,"description":"Remote identifier for the attribute."},"is_required":{"type":"boolean","description":"Indicates if the attribute is required. Defaults to False."},"is_variant":{"type":"boolean","description":"Indicates if the attribute is a variant. Defaults to False."},"is_custom":{"type":"boolean","description":"Indicates if the attribute is custom. Defaults to False."},"is_image_attribute":{"type":"boolean","description":"Indicates if the attribute is an image attribute. Defaults to False."},"is_meta":{"type":"boolean","description":"Indicates if the attribute is a meta attribute. Defaults to False."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp of the last modification."},"created_date":{"type":"string","readOnly":true,"format":"date-time","description":"Timestamp when this market place attribute config was created."}}}}}} ``` ## The MarketPlaceAttributeConfigGet object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeConfigGet":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the attribute configuration."},"attribute_set":{"type":"integer","description":"ID of the associated attribute set."},"attribute_set_name":{"type":"string","description":"Name of the associated attribute set."},"attribute":{"type":"integer","description":"ID of the associated attribute."},"attribute_name":{"type":"string","description":"Name of the associated attribute."},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"ID of the locale-specific attribute schema."},"attribute_remote_id":{"type":"string","nullable":true,"description":"Remote identifier for the attribute."},"is_required":{"type":"boolean","description":"Indicates if the attribute is required. Defaults to False."},"is_variant":{"type":"boolean","description":"Indicates if the attribute is a variant. Defaults to False."},"is_custom":{"type":"boolean","description":"Indicates if the attribute is custom. Defaults to False."},"is_image_attribute":{"type":"boolean","description":"Indicates if the attribute is an image attribute. Defaults to False."},"is_meta":{"type":"boolean","description":"Indicates if the attribute is a meta attribute. Defaults to False."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp of the last modification."}}}}}} ``` ## The MarketPlaceAttributeConfigGetDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeConfigGetDetailed":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the attribute configuration."},"attribute_set":{"type":"object","properties":{"pk":{"type":"integer","description":"ID of the attribute set."},"name":{"type":"string","description":"Name of the attribute set."},"channel":{"type":"integer","description":"ID of the channel."},"remote_id":{"type":"string","nullable":true,"description":"Remote identifier for the attribute set."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when this attribute set was created."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp of the last modification."}}},"attribute":{"type":"object","properties":{"pk":{"type":"integer","description":"ID of the attribute."},"name":{"type":"string","description":"Name of the attribute."},"channel":{"type":"integer","description":"ID of the channel."},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"ID of the locale attribute schema."},"modified_date":{"type":"string","format":"date-time","description":"Timestamp of the last modification."}}},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"ID of the locale-specific attribute schema."},"attribute_remote_id":{"type":"string","nullable":true,"description":"Remote identifier for the attribute."},"is_required":{"type":"boolean","description":"Indicates if the attribute is required. Defaults to False."},"is_variant":{"type":"boolean","description":"Indicates if the attribute is a variant. Defaults to False."},"is_custom":{"type":"boolean","description":"Indicates if the attribute is custom. Defaults to False."},"is_image_attribute":{"type":"boolean","description":"Indicates if the attribute is an image attribute. Defaults to False."},"is_meta":{"type":"boolean","description":"Indicates if the attribute is a meta attribute. Defaults to False."}}}}}} ``` ## The MarketPlaceAttributeConfigUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeConfigUpdate":{"type":"object","properties":{"locale_attribute_schema":{"type":"integer"},"is_required":{"type":"boolean"},"is_variant":{"type":"boolean"},"is_custom":{"type":"boolean"},"is_meta":{"type":"boolean"},"is_image_attribute":{"type":"boolean"}}}}}} ``` ## The MarketPlaceAttributeValueConfig object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeValueConfig":{"type":"object","properties":{"pk":{"type":"integer"},"attribute_set":{"type":"integer","description":"Associated marketplace attribute set id"},"attribute_value":{"type":"integer","description":"Associated marketplace attribute value id"},"created_date":{"type":"string","format":"date-time","description":"Creation date"},"modified_date":{"type":"string","format":"date-time","description":"Last modified date"}}}}}} ``` ## The DataSource object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]},"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."}}}}}} ``` ## The Channel object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The IntegrationActionCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"IntegrationActionCreate":{"type":"object","required":["channel_id","object_id"],"properties":{"channel_id":{"type":"integer","description":"ID of the channel"},"remote_id":{"type":"string","nullable":true,"description":"Remote ID of the integration action"},"version_date":{"type":"string","format":"date-time","nullable":true,"description":"Version date of the integration action"},"state":{"type":"object","description":"JSON representation of the state"},"object_id":{"type":"integer","description":"ID of the related object"},"content_type_id":{"type":"integer","nullable":true,"description":"ID of the content type"},"content_type_model":{"type":"string","nullable":true,"description":"Model name of the content type"}},"oneOf":[{"required":["content_type_id"]},{"required":["content_type_model"]}]}}}} ``` ## The IntegrationAction object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The IntegrationActionStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"}}}} ``` ## The SalesChannelRetailStore object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelRetailStore":{"$ref":"#/components/schemas/RetailStore"},"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}}},"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."}}},"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"}}}}}} ``` ## The SalesChannelRetailStoreSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}}}} ``` ## The SalesChannelRetailStoreDetailedSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelRetailStoreDetailedSerializer":{"$ref":"#/components/schemas/RetailStoreSerializerDetailed"},"RetailStoreSerializerDetailed":{"allOf":[{"$ref":"#/components/schemas/RetailStoreSerializer"}],"properties":{"township":{"$ref":"#/components/schemas/TownshipDetailed"},"district":{"$ref":"#/components/schemas/District"}}},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"TownshipDetailed":{"allOf":[{"$ref":"#/components/schemas/Township"}],"properties":{"city":{"$ref":"#/components/schemas/City"}}},"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."}}},"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"]},"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"]}}}} ``` ## The SalesChannelRetailStoreDistrictsSerializer object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelRetailStoreDistrictsSerializer":{"$ref":"#/components/schemas/RetailStoreDistrictsSerializer"},"RetailStoreDistrictsSerializer":{"type":"object","description":"A request to add or remove districts from a retail store.","properties":{"districts":{"type":"array","items":{"type":"integer"}}},"required":["districts"]}}}} ``` ## The BatchRequestStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BatchRequestStatus":{"type":"string","enum":["initialized","commit","sent_to_remote","ongoing","done","fail"],"description":"Status of the batch request"}}}} ``` ## The BatchRequestObject object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BatchRequestObject":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Primary key of the object"},"failed_reason_type":{"type":"string","nullable":true,"description":"Reason for failure if any"},"remote_id":{"type":"string","nullable":true,"maxLength":255,"description":"Remote ID of the object"},"version_date":{"type":"string","format":"date-time","nullable":true,"description":"Version date of the object"},"content_type":{"type":"string","maxLength":255,"description":"Content type of the object"}}}}}} ``` ## The BatchRequest object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BatchRequest":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Primary key of the batch request"},"channel":{"type":"integer","format":"int64","description":"ID of the channel"},"local_batch_id":{"type":"string","format":"uuid","description":"Local batch ID"},"remote_batch_id":{"type":"string","maxLength":255,"nullable":true,"description":"Remote batch ID"},"content_type":{"type":"string","maxLength":255,"nullable":true,"description":"Content type of the batch request"},"status":{"$ref":"#/components/schemas/BatchRequestStatus"},"objects":{"type":"array","items":{"$ref":"#/components/schemas/BatchRequestObject"},"nullable":true,"description":"List of objects in the batch request"},"created_date":{"type":"string","format":"date-time","description":"Creation date of the batch request"},"modified_date":{"type":"string","format":"date-time","description":"Last modification date of the batch request"}}},"BatchRequestStatus":{"type":"string","enum":["initialized","commit","sent_to_remote","ongoing","done","fail"],"description":"Status of the batch request"},"BatchRequestObject":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Primary key of the object"},"failed_reason_type":{"type":"string","nullable":true,"description":"Reason for failure if any"},"remote_id":{"type":"string","nullable":true,"maxLength":255,"description":"Remote ID of the object"},"version_date":{"type":"string","format":"date-time","nullable":true,"description":"Version date of the object"},"content_type":{"type":"string","maxLength":255,"description":"Content type of the object"}}}}}} ``` ## The BatchRequestCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BatchRequestCreate":{"type":"object","required":["channel"],"properties":{"channel":{"type":"integer","format":"int64","description":"ID of the channel"}}}}}} ``` ## The BatchRequestUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BatchRequestUpdate":{"type":"object","properties":{"channel":{"type":"integer","format":"int64","description":"ID of the channel"},"remote_batch_id":{"type":"string","maxLength":255,"nullable":true,"description":"Remote batch ID"},"content_type":{"type":"string","maxLength":255,"nullable":true,"description":"Content type of the batch request"},"status":{"$ref":"#/components/schemas/BatchRequestStatus"},"objects":{"type":"array","items":{"$ref":"#/components/schemas/BatchRequestObject"},"nullable":true,"description":"List of objects in the batch request"},"log_file":{"type":"string","nullable":true,"description":"Log file content"}}},"BatchRequestStatus":{"type":"string","enum":["initialized","commit","sent_to_remote","ongoing","done","fail"],"description":"Status of the batch request"},"BatchRequestObject":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Primary key of the object"},"failed_reason_type":{"type":"string","nullable":true,"description":"Reason for failure if any"},"remote_id":{"type":"string","nullable":true,"maxLength":255,"description":"Remote ID of the object"},"version_date":{"type":"string","format":"date-time","nullable":true,"description":"Version date of the object"},"content_type":{"type":"string","maxLength":255,"description":"Content type of the object"}}}}}} ``` ## The MarketPlaceAttributeSet object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSet":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"channel":{"type":"integer","nullable":true},"remote_id":{"type":"string","maxLength":255,"nullable":true},"created_date":{"type":"string","format":"date-time"},"modified_date":{"type":"string","format":"date-time"}}}}}} ``` ## The ErrorReportIntegrationMapping object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ErrorReportIntegrationMapping":{"type":"object","required":["remote_code","country_id","integration_type","err_code","err_desc"],"properties":{"remote_code":{"type":"string","maxLength":255,"description":"The remote code for the integration mapping"},"city_id":{"type":"integer","nullable":true,"description":"ID of the city"},"country_id":{"type":"integer","nullable":true,"description":"ID of the country"},"township_id":{"type":"integer","nullable":true,"description":"ID of the township"},"name":{"type":"string","nullable":true,"description":"Name of the integration mapping"},"integration_type":{"$ref":"#/components/schemas/IntegrationMappingType"},"err_code":{"type":"string","nullable":true,"description":"Error code if any"},"err_desc":{"type":"string","nullable":true,"description":"Error description if any"}}},"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"]}}}} ``` ## The SalesChannelCategoryNode object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCategoryNode":{"$ref":"#/components/schemas/CategoryNode"},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}}}} ``` ## The SalesChannelCategoryNodeDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCategoryNodeDetailed":{"$ref":"#/components/schemas/CategoryNodeDetailed"},"CategoryNodeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"object","$ref":"#/components/schemas/SortOptionDetailed"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}},"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"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."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]}}}} ``` ## The SalesChannelCategoryNodeCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCategoryNodeCreate":{"$ref":"#/components/schemas/CategoryNodeCreate"},"CategoryNodeCreate":{"type":"object","required":["name","node"],"properties":{"name":{"type":"string","description":"Name of the category node","maxLength":64},"order":{"type":"integer","description":"Order of the category node within its level"},"node":{"type":"string","description":"Parent node information for creating child category node"},"sort_option":{"type":"integer","nullable":true,"description":"ID of the sort option for the category node"},"attributes":{"type":"object","description":"Dynamic attributes for the category node","nullable":true}}}}}} ``` ## The SalesChannelCategoryNodeUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCategoryNodeUpdate":{"$ref":"#/components/schemas/CategoryNodeUpdate"},"CategoryNodeUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Name of the category node","maxLength":64},"order":{"type":"integer","description":"Order of the category node"},"sort_option":{"type":"integer","nullable":true,"description":"ID of the sort option for the category node"},"attributes":{"type":"object","description":"Dynamic attributes for the category node"}}}}}} ``` ## The SalesChannelCategoryNodeMove object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCategoryNodeMove":{"$ref":"#/components/schemas/CategoryNodeMove"},"CategoryNodeMove":{"type":"object","required":["node","target","pos"],"properties":{"node":{"type":"integer","description":"ID of the node to move (must have depth greater than 1)"},"target":{"type":"integer","description":"ID of the target node to move to (must have depth greater than 1)"},"pos":{"type":"string","enum":["left","right"],"description":"Position relative to the target node"}}}}}} ``` ## The GetOrder object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderOrderCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderOrderUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderDataSource object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"GetOrderDataSource":{"$ref":"#/components/schemas/OrderDataSource"},"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."}}}}}} ``` ## The GetOrderChangeBillingAddress object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderChangeShippingAddress object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderChangeStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"}}}} ``` ## The GetOrderCreateMapping object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderCreateMappingResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}},"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"]},"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."}}}}}} ``` ## The GetOrderRefund object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderCancelOrder object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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."}}}}}} ``` ## The GetOrderCancelStatusUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderDetailedList object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The GetOrderSplitPackages object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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."}}}}}} ``` ## The GetOrderGatewayPosHistory object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"GetOrderGatewayPosHistory":{"$ref":"#/components/schemas/OrderGatewayPosHistory"},"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"}}}}}}}} ``` ## The GetCaptureOrder object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"GetCaptureOrder":{"$ref":"#/components/schemas/CaptureOrder"},"CaptureOrder":{"properties":{"force_refund":{"type":"boolean"}}}}}} ``` ## The GetOrderBulkReplaceProduct object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"}}}}}} ``` ## The GetOrderBulkReduceWeight object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"}}}}}} ``` ## The GetOrderBulkReplaceProductAndReduceWeight object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"}}}}}} ``` ## The SalesChannelCancellationPlan object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCancellationPlan":{"$ref":"#/components/schemas/CancellationPlan"},"CancellationPlan":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan"},"order":{"$ref":"#/components/schemas/Order"},"invoice_number":{"type":"string","description":"Invoice number associated with the cancellation plan"},"order_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Amount refunded for shipping"},"status":{"$ref":"#/components/schemas/CancellationPlanStatus"},"retail_store_remote_id":{"type":"string","description":"Remote ID of the retail store associated with the cancellation plan"},"refund_amount":{"type":"number","format":"float","description":"Refund amount"},"discount_refund_amount":{"type":"number","format":"float","description":"Discount refund amount"},"plan_type":{"$ref":"#/components/schemas/CancellationPlanType"},"cancellationplanorderitem_set":{"type":"array","items":{"$ref":"#/components/schemas/CancellationPlanOrderItemDetailed"}},"staff_remote_id":{"type":"string","description":"Remote ID of the staff member"},"created_by":{"$ref":"#/components/schemas/User"},"last_updated_by":{"$ref":"#/components/schemas/User"},"payment_plan":{"type":"object","description":"A JSON object to store payment plan details"},"modified_by_id":{"type":"integer","description":"ID of the user who last modified the cancellation plan"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]},"OrderStatus":{"type":"string","enum":["cancellation_waiting","cancelled","waiting","payment_waiting","confirmation_waiting","approved","preparing","shipped","shipped_and_informed","ready_for_pickup","attempted_delivery","review_started","review_waiting","waiting_for_payment","paid","delivered","refunded"],"description":"Status of the order item"},"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]},"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]},"CancellationPlanOrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation plan order item"},"order_item":{"$ref":"#/components/schemas/OrderItemDetailed"},"order_item_previous_status":{"$ref":"#/components/schemas/OrderStatus"},"status":{"$ref":"#/components/schemas/OrderStatus"},"reason":{"$ref":"#/components/schemas/CancellationReason"},"modified_date":{"type":"string","format":"date-time","description":"Date and time when the cancellation plan order item was modified"}}},"OrderItemDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Order Item ID"},"order":{"$ref":"#/components/schemas/Order"},"product":{"type":"object","$ref":"#/components/schemas/Product"},"price_list":{"type":"object","$ref":"#/components/schemas/PriceList"},"stock_list":{"type":"object","$ref":"#/components/schemas/StockList"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate of the item"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","nullable":true},"shipment_code":{"type":"string","description":"Shipment code for the item","nullable":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","nullable":true},"is_tradable":{"type":"boolean","description":"Indicates if the item is tradable","readOnly":true},"installment_interest_amount":{"type":"number","format":"decimal","description":"Installment interest amount","nullable":true},"benefitapplicant_set":{"type":"array","items":{"$ref":"#/components/schemas/BenefitApplicant"},"nullable":true},"external_status":{"type":"object","$ref":"#/components/schemas/OrderExternalStatus"},"datasource":{"type":"object","$ref":"#/components/schemas/DataSource","nullable":true},"tracking_url":{"type":"string","format":"uri","description":"Tracking URL for the item","readOnly":true},"shipping_option_group":{"type":"object","$ref":"#/components/schemas/ShippingOptionGroup"},"forced_refund":{"type":"boolean","description":"Indicates if refund is forced","nullable":true},"extra_field":{"type":"object","description":"Extra field for additional data","nullable":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"User":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_active":{"type":"boolean","description":"Indicates if the user is active"},"is_staff":{"type":"boolean","description":"Indicates if the user is a staff member"},"is_superuser":{"type":"boolean","description":"Indicates if the user is a superuser"},"date_joined":{"type":"string","format":"date-time","description":"Date and time when the user joined"},"last_login":{"type":"string","format":"date-time","description":"Date and time of the user's last login"},"groups":{"type":"array","items":{"type":"integer","description":"ID of the group"}},"can_read_sensitive_data":{"type":"boolean","description":"Indicates if the user can read sensitive data"}}}}}} ``` ## The SalesChannelProductPrice object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelProductPrice":{"$ref":"#/components/schemas/ProductPrice"},"ProductPrice":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Product Price ID"},"product":{"type":"integer","nullable":false,"description":"ID of the product related with the price."},"price_list":{"type":"integer","nullable":false,"description":"ID of the price list related with the price."},"retail_price":{"type":"number","format":"decimal","nullable":true,"description":"Retail price of the product, can be null or blank."},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate applied to the product price."},"currency_type":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"The actual price of the product."},"price_type":{"type":"string","description":"Type of the price.","enum":["default","range_"]},"discount_percentage":{"type":"number","format":"decimal","description":"Discount percentage applied to the price, if any."},"extra_field":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Extra fields related to the product price in JSON format."},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Product Price"},"modified_date":{"type":"string","format":"date-time","description":"Modification Date of the Product Price"}}},"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"]}}}} ``` ## The SalesChannelProductPriceDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelProductPriceDetailed":{"$ref":"#/components/schemas/ProductPriceDetailed"},"ProductPriceDetailed":{"allOf":[{"$ref":"#/components/schemas/ProductPrice"}],"properties":{"product":{"$ref":"#/components/schemas/Product"},"price_list":{"$ref":"#/components/schemas/PriceList"}}},"ProductPrice":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Product Price ID"},"product":{"type":"integer","nullable":false,"description":"ID of the product related with the price."},"price_list":{"type":"integer","nullable":false,"description":"ID of the price list related with the price."},"retail_price":{"type":"number","format":"decimal","nullable":true,"description":"Retail price of the product, can be null or blank."},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate applied to the product price."},"currency_type":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"The actual price of the product."},"price_type":{"type":"string","description":"Type of the price.","enum":["default","range_"]},"discount_percentage":{"type":"number","format":"decimal","description":"Discount percentage applied to the price, if any."},"extra_field":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Extra fields related to the product price in JSON format."},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Product Price"},"modified_date":{"type":"string","format":"date-time","description":"Modification Date of the Product Price"}}},"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"]},"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"}}}}}} ``` ## The FailedIntegration object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"FailedIntegration":{"type":"object","properties":{"pk":{"type":"integer","description":"Unique identifier for the failed integration","readOnly":true},"channel":{"type":"integer","description":"Foreign key to Channel model"},"version_date":{"type":"string","format":"date-time","description":"Version date of the integration attempt (indexed)"},"reason_type":{"type":"string","enum":["mapping","remote","channel_app"],"description":"Type of reason for failure","maxLength":15},"is_active":{"type":"boolean","description":"Whether the failed integration is active","default":true},"content_type":{"type":"integer","description":"Foreign key to ContentType model for polymorphic relationship"},"object_id":{"type":"integer","description":"ID of the related object"},"expiration_date":{"type":"string","format":"date-time","description":"Date when the failed integration record expires","nullable":true},"retry_count":{"type":"integer","description":"Number of retry attempts made","default":1,"minimum":0},"max_retry_count":{"type":"integer","description":"Maximum number of retry attempts allowed","default":1,"minimum":0},"retry_interval":{"type":"integer","description":"Interval between retry attempts in seconds","default":0,"minimum":0},"integration_action":{"type":"integer","description":"Foreign key to IntegrationAction model","nullable":true},"log_id":{"type":"integer","description":"ID reference to related log entry","nullable":true}},"required":["channel","version_date","reason_type","content_type","object_id"]}}}} ``` ## The ProductCategory object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductCategory":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Product Category ID","readOnly":true},"product":{"type":"integer","format":"int64","description":"Foreign key to Product object"},"category":{"type":"integer","format":"int64","description":"Foreign key to CategoryNode object"},"modified_date":{"type":"string","format":"date-time","description":"Last modification date of the product category relationship","readOnly":true},"created_date":{"type":"string","format":"date-time","description":"Creation date of the product category relationship","readOnly":true}}}}}} ``` ## The ProductCategoryDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ProductCategoryDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Product Category ID","readOnly":true},"product":{"$ref":"#/components/schemas/Product"},"category":{"$ref":"#/components/schemas/CategoryNode"}}},"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"]},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}}}} ``` ## The BulkProcessStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BulkProcessStatus":{"type":"object","properties":{"progress":{"type":"array","items":{"type":"array","items":{"type":"integer"}},"description":"Progress information for each chunk, where the first value is the current progress and the second is the total size"},"errors":{"type":"array","items":{"type":"string"},"description":"List of errors encountered during the operation"},"chunk_count":{"type":"integer","description":"Total number of chunks the operation was divided into"},"status":{"type":"string","enum":["waiting","in_progress","completed","failed"],"description":"Current status of the bulk operation"}}}}}} ``` ## The MarketPlaceAttributeSchema object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSchema":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"schema":{"type":"object"},"channel":{"type":"integer"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}},"required":["name","schema","channel"]}}}} ``` ## The MarketPlaceAttributeSchemaCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSchemaCreate":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"schema":{"type":"object"},"channel":{"type":"integer","description":"Sales channel id"}},"required":["name"]}}}} ``` ## The MarketPlaceAttributeSchemaUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSchemaUpdate":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"schema":{"type":"object"},"channel":{"type":"integer","description":"Sales channel id"}},"required":["name","schema","channel"]}}}} ``` ## The MarketPlaceAttributeSchemaPatch object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeSchemaPatch":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"schema":{"type":"object"},"channel":{"type":"integer","description":"Sales channel id"}}}}}} ``` ## The SalesChannelCancellationRequest object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCancellationRequest":{"$ref":"#/components/schemas/CancellationRequest"},"CancellationRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"}],"properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Cancellation Request ID"},"order_item":{"type":"integer","description":"Related order item ID"},"reason":{"type":"integer","description":"Related cancellation reason ID"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"status":{"$ref":"#/components/schemas/CancellationRequestStatus"},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"easy_return":{"type":"object","$ref":"#/components/schemas/CancellationEasyReturn","nullable":true},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true},"fully_refund_as_loyalty_money":{"type":"boolean","description":"Flag to indicate if the refund should be processed as loyalty money","default":false}},"required":["id","order_item","reason","cancellation_type","status","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"CancellationEasyReturn":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation easy return","readOnly":true},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"code":{"type":"string","description":"Code for the cancellation easy return","nullable":true},"start_date":{"type":"string","format":"date-time","description":"Start date of the cancellation easy return","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the cancellation easy return","nullable":true},"max_count":{"type":"integer","description":"Maximum number of returns allowed","nullable":true},"status":{"$ref":"#/components/schemas/CancellationEasyReturnStatus"},"raw_request":{"type":"string","description":"Raw request data for the cancellation easy return","nullable":true},"raw_response":{"type":"string","description":"Raw response data for the cancellation easy return","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for return","nullable":true},"tracking_url":{"type":"string","format":"uri","maxLength":4096,"description":"Tracking URL for return, if available","nullable":true},"pickup_date":{"type":"object","nullable":false,"default":{},"description":"JSON field to store pickup date-related data"}}},"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"]},"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]}}}} ``` ## The SalesChannelCancellationRequestDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCancellationRequestDetailed":{"$ref":"#/components/schemas/CancellationRequestDetailed"},"CancellationRequestDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Cancellation Request ID"},"order_item":{"type":"object","$ref":"#/components/schemas/OrderItemDetailed"},"reason":{"type":"object","$ref":"#/components/schemas/CancellationReason"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"status":{"$ref":"#/components/schemas/CancellationRequestStatus"},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"easy_return":{"type":"object","$ref":"#/components/schemas/CancellationEasyReturn","nullable":true},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true},"fully_refund_as_loyalty_money":{"type":"boolean","description":"Flag to indicate if the refund should be processed as loyalty money","default":false},"channel":{"type":"object","$ref":"#/components/schemas/Channel"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"}}},"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}}},"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."}}},"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."}}},"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"]},"Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"Unique identifier for the product"},"name":{"type":"string","description":"Name of the product","maxLength":255},"base_code":{"type":"string","description":"Base code for product variants","nullable":true},"sku":{"type":"string","description":"Stock keeping unit - unique identifier for the product","maxLength":255},"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the product price."},"description":{"type":"string","description":"Detailed description of the product","maxLength":512,"nullable":true},"brand":{"type":"integer","description":"Foreign key to Brand model","nullable":true},"erp_categories":{"type":"array","items":{"type":"integer"},"description":"List of ERP category IDs"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate percentage","maximum":999.99,"minimum":0,"nullable":true},"weight":{"type":"number","format":"decimal","description":"Product weight","maximum":99999999.99,"minimum":0,"nullable":true},"product_type":{"type":"string","enum":["pre_product","simple","product_meta","bundle","grouped","pre_miscellaneous","miscellaneous","offer"],"description":"Type of the product"},"productization_date":{"type":"string","format":"date-time","nullable":true,"description":"Date when product was productized from pre status"},"data_source":{"type":"integer","description":"Foreign key to DataSource model","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was created"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the product was last updated"},"is_active":{"type":"boolean","description":"Whether the product is currently active","default":true},"attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true},"parent":{"type":"integer","description":"Foreign key to parent Product","nullable":true},"group_products":{"type":"array","items":{"type":"integer"},"description":"List of product IDs in the group","nullable":true},"attributes":{"type":"object","description":"Dynamic attributes stored as JSON","additionalProperties":true,"nullable":true},"listing_code":{"type":"string","description":"Listing code for the product","nullable":true},"is_seller_product":{"type":"boolean","description":"Whether the product is a seller product","default":false},"custom_attribute_set":{"type":"integer","description":"Foreign key to AttributeSet model","nullable":true}},"required":["name","sku","barcode","product_type"]},"PriceList":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","description":"Price List ID"},"name":{"type":"string","maxLength":64,"description":"Name of the price list."},"code":{"type":"string","nullable":true,"maxLength":64,"description":"Unique code for the price list. Can be null or blank."},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"is_auto_sync":{"type":"boolean","description":"Indicates whether the price list is auto-synchronized with an external integration.","default":false},"created_date":{"type":"string","format":"date-time","description":"Creation Date of the Price List"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date of the Price List"}}},"CurrencyEnum":{"type":"string","description":"Currency type for the price list.","enum":["tr","eu","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"StockList":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the stock list","readOnly":true},"name":{"type":"string","description":"The name of the stock list","maxLength":255},"code":{"type":"string","description":"The code of the stock list","maxLength":50},"is_auto_sync":{"type":"boolean","description":"Indicates if the stock list is set to auto-sync","default":false}}},"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"},"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"BenefitApplicant":{"type":"object","description":"Represents a benefit applicant in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the benefit applicant","readOnly":true},"discount_item":{"type":"integer","description":"The ID of the discount item associated with this benefit applicant"},"order_item":{"type":"integer","description":"The ID of the order item associated with this benefit applicant"},"discount_share":{"type":"number","format":"decimal","description":"The share amount of the discount","minimum":0}},"required":["discount_item","order_item","discount_share"]},"OrderExternalStatus":{"type":"object","description":"A model representing external statuses of an order with a name and unique code.","properties":{"pk":{"type":"integer","description":"Unique identifier for the order.","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the external status."},"name":{"type":"string","maxLength":64,"description":"The name of the external status."},"code":{"type":"string","maxLength":64,"description":"A unique code representing the external status."},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"}},"required":["name","code"]},"DataSource":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Data Source ID"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly version of the name","readOnly":true},"stock_list":{"type":"integer","description":"Related stock list ID"},"price_list":{"type":"integer","description":"Related price list ID"},"is_active":{"type":"boolean","description":"Indicates if the data source is active","default":true},"token":{"type":"string","description":"Authentication token for the data source","readOnly":true},"conf":{"type":"object","description":"Configuration settings for the data source","default":{},"nullable":true},"commission":{"type":"number","format":"decimal","description":"Commission rate for the data source","default":0,"minimum":0,"maximum":100},"maturity":{"type":"integer","description":"Maturity period in days","readOnly":true},"supplier_code":{"type":"string","description":"Supplier code for the data source","nullable":true},"supplier_detail":{"type":"object","description":"Supplier details","default":{},"nullable":true},"easy_return_detail":{"type":"object","description":"Easy return details","default":{},"nullable":true},"extras":{"type":"object","description":"Additional data source information","default":{},"nullable":true},"data_source_type":{"type":"string","description":"Type of the data source","enum":["unified","distributed"],"default":"unified"}},"required":["pk","name","created_date","modified_date"]},"ShippingOptionGroup":{"type":"object","description":"Represents a shipping option group in the system","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"The unique identifier for the shipping option group","readOnly":true},"amount":{"type":"number","format":"decimal","description":"The amount of the shipping option group"},"tax_rate":{"type":"number","format":"decimal","description":"The tax rate of the shipping option group"},"shipping_option_slug":{"type":"string","format":"slug","description":"The slug of the shipping option group","maxLength":128,"nullable":true},"created_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the shipping option group was last modified","readOnly":true}},"required":["amount","tax_rate"]},"CancellationReason":{"type":"object","description":"Represents a reason for order cancellation","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the cancellation reason","readOnly":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"extra_information_needed":{"type":"boolean","description":"Whether extra information is needed for this cancellation reason","default":false},"order":{"type":"integer","description":"Order of display for the cancellation reason","default":100},"subject":{"type":"string","description":"Subject/name of the cancellation reason","maxLength":100},"is_active":{"type":"boolean","description":"Whether the cancellation reason is active","default":true},"send_to_remote":{"type":"boolean","description":"Whether to send this reason to remote systems"},"send_to_oms":{"type":"boolean","description":"Whether to send this reason to OMS"},"translations":{"type":"object","description":"Translations for the cancellation reason","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for the cancellation reason","readOnly":true}},"required":["cancellation_type","subject"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]},"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"CancellationEasyReturn":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation easy return","readOnly":true},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"code":{"type":"string","description":"Code for the cancellation easy return","nullable":true},"start_date":{"type":"string","format":"date-time","description":"Start date of the cancellation easy return","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the cancellation easy return","nullable":true},"max_count":{"type":"integer","description":"Maximum number of returns allowed","nullable":true},"status":{"$ref":"#/components/schemas/CancellationEasyReturnStatus"},"raw_request":{"type":"string","description":"Raw request data for the cancellation easy return","nullable":true},"raw_response":{"type":"string","description":"Raw response data for the cancellation easy return","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for return","nullable":true},"tracking_url":{"type":"string","format":"uri","maxLength":4096,"description":"Tracking URL for return, if available","nullable":true},"pickup_date":{"type":"object","nullable":false,"default":{},"description":"JSON field to store pickup date-related data"}}},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]},"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"]}}}} ``` ## The SalesChannelCancellationRequestCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCancellationRequestCreate":{"$ref":"#/components/schemas/CancellationRequestCreate"},"CancellationRequestCreate":{"type":"object","required":["order_item","reason","cancellation_type"],"properties":{"order_item":{"type":"integer","description":"Related order item ID"},"reason":{"type":"integer","description":"Related cancellation reason ID"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true}}},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The SalesChannelCancellationRequestUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCancellationRequestUpdate":{"$ref":"#/components/schemas/CancellationRequestUpdate"},"CancellationRequestUpdate":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/CancellationRequestStatus"},"description":{"type":"string","description":"Description of the cancellation request","nullable":true},"iban":{"type":"string","description":"IBAN for refund","nullable":true},"holder_name":{"type":"string","description":"Name of the account holder","nullable":true},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"quantity":{"type":"integer","description":"Quantity of items to be cancelled","minimum":1,"nullable":true},"fully_refund_as_loyalty_money":{"type":"boolean","description":"Flag to indicate if the refund should be processed as loyalty money","default":false},"reason":{"type":"integer","description":"Related cancellation reason ID"},"order_item":{"type":"integer","description":"Related order item ID"}}},"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]},"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The SalesChannelCancellationEasyReturn object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCancellationEasyReturn":{"$ref":"#/components/schemas/CancellationEasyReturn"},"CancellationEasyReturn":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"}],"properties":{"id":{"type":"integer","description":"Unique identifier for the cancellation easy return","readOnly":true},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"code":{"type":"string","description":"Code for the cancellation easy return","nullable":true},"start_date":{"type":"string","format":"date-time","description":"Start date of the cancellation easy return","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the cancellation easy return","nullable":true},"max_count":{"type":"integer","description":"Maximum number of returns allowed","nullable":true},"status":{"$ref":"#/components/schemas/CancellationEasyReturnStatus"},"raw_request":{"type":"string","description":"Raw request data for the cancellation easy return","nullable":true},"raw_response":{"type":"string","description":"Raw response data for the cancellation easy return","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for return","nullable":true},"tracking_url":{"type":"string","format":"uri","maxLength":4096,"description":"Tracking URL for return, if available","nullable":true},"pickup_date":{"type":"object","nullable":false,"default":{},"description":"JSON field to store pickup date-related data"}}},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"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"]},"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]}}}} ``` ## The MarketPlaceAttributeValue object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeValue":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier of the attribute"},"attribute":{"type":"integer","description":"Associated MarketPlaceAttribute id"},"label":{"type":"string","maxLength":750,"description":"Label value of the MarketPlaceAttributeValue data"},"value":{"type":"string","maxLength":750,"nullable":true,"description":"Value of the MarketPlaceAttributeValue data"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Creation date of the data"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Last modification date"}},"required":["attribute","label"]}}}} ``` ## The MarketPlaceAttributeValueCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeValueCreate":{"type":"object","properties":{"attribute":{"type":"integer","description":"ID value of the associated MarketPlaceAttribute data"},"label":{"type":"string","maxLength":750,"description":"Label value of the MarketPlaceAttributeValue data"},"value":{"type":"string","maxLength":750,"nullable":true,"description":"Value of the MarketPlaceAttributeValue data"}},"required":["attribute","label"]}}}} ``` ## The MarketPlaceAttributeValueUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeValueUpdate":{"type":"object","properties":{"label":{"type":"string","maxLength":750,"description":"Label value of the MarketPlaceAttributeValue data"},"value":{"type":"string","maxLength":750,"description":"Value of the MarketPlaceAttributeValue data"}}}}}} ``` ## The SalesChannelMappedProductResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelMappedProductResponse":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the mapped product"},"mapped_attributes":{"type":"object","description":"A key-value map of all attributes for the product in the given channel."},"mapped_attribute_values":{"type":"object","description":"A dictionary of attribute values with additional metadata.","additionalProperties":{"type":"object","properties":{"attribute_name":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"},"attribute_remote_id":{"type":"string"}}}},"attribute_set_id":{"type":"integer","description":"ID of the related attribute set."},"attribute_set_name":{"type":"string","nullable":true,"description":"Name of the related attribute set."},"attribute_set_remote_id":{"type":"string","nullable":true,"description":"Remote ID of the related attribute set."},"modified_date":{"type":"string","format":"date-time","description":"Date when the product was last modified."}}}}}} ``` ## The MarketPlaceAttribute object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttribute":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier of the attribute"},"name":{"type":"string","maxLength":255,"description":"Name of the attribute"},"channel":{"type":"integer","description":"Associated channel ID"},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"Associated schema ID, can be null"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Last modification date"}},"required":["name","channel"]}}}} ``` ## The MarketPlaceAttributeCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeCreate":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"Name of the attribute"},"channel":{"type":"integer","description":"Associated channel ID"},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"Associated schema ID, can be null"}},"required":["name","channel"]}}}} ``` ## The MarketPlaceAttributeUpdate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeUpdate":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"Name of the attribute"},"channel":{"type":"integer","description":"Associated channel ID"},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"Associated schema ID, can be null"}}}}}} ``` ## The MarketPlaceAttributeList object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MarketPlaceAttributeList":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of records"},"next":{"type":"string","nullable":true,"format":"uri","description":"URL of the next page"},"previous":{"type":"string","nullable":true,"format":"uri","description":"URL of the previous page"},"results":{"type":"array","items":{"$ref":"#/components/schemas/MarketPlaceAttribute"},"description":"List of results"}}},"MarketPlaceAttribute":{"type":"object","properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier of the attribute"},"name":{"type":"string","maxLength":255,"description":"Name of the attribute"},"channel":{"type":"integer","description":"Associated channel ID"},"locale_attribute_schema":{"type":"integer","nullable":true,"description":"Associated schema ID, can be null"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Last modification date"}},"required":["name","channel"]}}}} ``` ## The IntegrationMapping object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}},"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."}}}}}} ``` ## The OrderCreate object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderCreate":{"type":"object","required":["order","order_item"],"properties":{"order":{"allOf":[{"$ref":"#/components/schemas/CreateOrder"},{"type":"object","description":"Order data containing all necessary information"}]},"order_item":{"type":"array","description":"List of items in the order","items":{"type":"object","required":["product","quantity","unit_price","total_price"],"properties":{"order":{"type":"integer","description":"ID of the order (optional, can be null)"},"product":{"type":"integer","description":"ID of the product"},"status":{"$ref":"#/components/schemas/OrderStatus"},"price_currency":{"$ref":"#/components/schemas/CurrencyEnum"},"price":{"type":"number","format":"decimal","description":"Price of the product"},"quantity":{"type":"integer","description":"Quantity of the product"},"unit_price":{"type":"number","format":"decimal","description":"Price per unit"},"total_price":{"type":"number","format":"decimal","description":"Total price for this item"},"tax_rate":{"type":"number","format":"decimal","description":"Tax rate applied to this item"},"tax_amount":{"type":"number","format":"decimal","description":"Total tax amount for this item"},"extra_field":{"type":"object","description":"Additional information as JSON"},"price_list":{"type":"integer","description":"ID of the price list"},"stock_list":{"type":"integer","description":"ID of the stock list"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"shipment_code":{"type":"string","description":"Shipment tracking code"},"attributes":{"type":"object","description":"Additional attributes as JSON"},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum"},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest amount for installment"},"is_tradable":{"type":"boolean","description":"Whether the item is tradable"},"datasource":{"type":"integer","description":"ID of the data source"},"localized_attributes":{"type":"object","description":"Localized attributes"},"localized_attributes_kwargs":{"type":"object","description":"Additional arguments for localized attributes"},"cancellation_reconciliation":{"type":"integer","description":"Cancellation reconciliation ID"},"reconciliation":{"type":"integer","description":"Reconciliation ID"},"forced_refund":{"type":"boolean","description":"Whether refund was forced"},"original_stock":{"type":"integer","description":"Original stock ID"},"shipping_option_group":{"type":"integer","description":"Shipping option group ID"},"e_archive_url":{"type":"string","format":"uri","description":"URL to the electronic archive","readOnly":true},"tracking_number":{"type":"string","description":"Shipment tracking number","readOnly":true},"carrier_shipping_code":{"type":"string","description":"Shipping code from the carrier","readOnly":true},"external_status":{"type":"integer","description":"External status reference ID","readOnly":true},"discount_amount":{"type":"number","format":"decimal","description":"Discount amount applied to this item"},"retail_price":{"type":"number","format":"decimal","description":"Retail price of the item"},"image":{"type":"string","format":"binary","description":"Image file upload"},"parent":{"type":"integer","description":"ID of the parent order item"},"estimated_delivery_date":{"type":"string","format":"date","description":"Estimated delivery date"},"defined_tracking_url":{"type":"string","format":"uri","description":"Custom tracking URL"},"defined_shipping_company":{"type":"string","description":"Custom shipping company name"}}}}}},"CreateOrder":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"number":{"type":"string","description":"Order number, unique within the context of a channel"},"channel":{"type":"integer","description":"ID of the channel through which the order was placed"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed"},"customer":{"type":"integer","description":"ID of the customer who placed the order"},"shipping_address":{"type":"integer","description":"ID of the shipping address"},"billing_address":{"type":"integer","description":"ID of the billing address"},"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"},"payment_option":{"type":"integer","description":"ID of the payment option used"},"payment_option_slug":{"type":"string","description":"Slug of the payment option"},"bin_number":{"type":"string","description":"First 6 digits of the customer's card"},"installment":{"type":"integer","description":"ID of the installment option selected"},"installment_count":{"type":"integer","description":"Number of installments for the payment"},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"description":"Type of delivery selected"},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments"},"cargo_company":{"type":"integer","description":"ID of the company responsible for shipping"},"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":"uri","description":"URL for the e-archive of the invoice"},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order"},"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"},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount","readOnly":true},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost"},"tracking_number":{"type":"string","description":"Tracking number for the order"},"carrier_shipping_code":{"type":"string","description":"Shipping code from the carrier"},"remote_addr":{"type":"string","description":"IP address from where the order was placed"},"fundstransfertransaction_set":{"type":"array","items":{"type":"integer"},"description":"Set of funds transfer transaction IDs"},"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":{"type":"integer","description":"ID of the external status"},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order"},"language_code":{"type":"string","description":"Language code for the order"},"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"},"modified_date":{"type":"string","format":"date-time","description":"Last modification date of the order"},"checkout_provider_id":{"type":"integer","description":"ID of the provider used for checkout"},"created_date":{"type":"string","format":"date-time","description":"Creation date of the order"},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","readOnly":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","readOnly":true},"defined_tracking_url":{"type":"string","format":"uri","description":"Custom tracking URL"},"installment_free":{"type":"boolean","description":"Whether installment is free","readOnly":true},"first_refund_strategy":{"type":"string","description":"First refund strategy","readOnly":true}}},"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"},"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"]},"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"]}}}} ``` ## The OrderResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderResponse":{"$ref":"#/components/schemas/CreateOrder"},"CreateOrder":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"number":{"type":"string","description":"Order number, unique within the context of a channel"},"channel":{"type":"integer","description":"ID of the channel through which the order was placed"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed"},"customer":{"type":"integer","description":"ID of the customer who placed the order"},"shipping_address":{"type":"integer","description":"ID of the shipping address"},"billing_address":{"type":"integer","description":"ID of the billing address"},"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"},"payment_option":{"type":"integer","description":"ID of the payment option used"},"payment_option_slug":{"type":"string","description":"Slug of the payment option"},"bin_number":{"type":"string","description":"First 6 digits of the customer's card"},"installment":{"type":"integer","description":"ID of the installment option selected"},"installment_count":{"type":"integer","description":"Number of installments for the payment"},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"description":"Type of delivery selected"},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments"},"cargo_company":{"type":"integer","description":"ID of the company responsible for shipping"},"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":"uri","description":"URL for the e-archive of the invoice"},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order"},"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"},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount","readOnly":true},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost"},"tracking_number":{"type":"string","description":"Tracking number for the order"},"carrier_shipping_code":{"type":"string","description":"Shipping code from the carrier"},"remote_addr":{"type":"string","description":"IP address from where the order was placed"},"fundstransfertransaction_set":{"type":"array","items":{"type":"integer"},"description":"Set of funds transfer transaction IDs"},"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":{"type":"integer","description":"ID of the external status"},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order"},"language_code":{"type":"string","description":"Language code for the order"},"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"},"modified_date":{"type":"string","format":"date-time","description":"Last modification date of the order"},"checkout_provider_id":{"type":"integer","description":"ID of the provider used for checkout"},"created_date":{"type":"string","format":"date-time","description":"Creation date of the order"},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","readOnly":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","readOnly":true},"defined_tracking_url":{"type":"string","format":"uri","description":"Custom tracking URL"},"installment_free":{"type":"boolean","description":"Whether installment is free","readOnly":true},"first_refund_strategy":{"type":"string","description":"First refund strategy","readOnly":true}}},"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"},"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"]},"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"]}}}} ``` ## The CreateOrder object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CreateOrder":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"number":{"type":"string","description":"Order number, unique within the context of a channel"},"channel":{"type":"integer","description":"ID of the channel through which the order was placed"},"status":{"$ref":"#/components/schemas/OrderStatus"},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed"},"customer":{"type":"integer","description":"ID of the customer who placed the order"},"shipping_address":{"type":"integer","description":"ID of the shipping address"},"billing_address":{"type":"integer","description":"ID of the billing address"},"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"},"payment_option":{"type":"integer","description":"ID of the payment option used"},"payment_option_slug":{"type":"string","description":"Slug of the payment option"},"bin_number":{"type":"string","description":"First 6 digits of the customer's card"},"installment":{"type":"integer","description":"ID of the installment option selected"},"installment_count":{"type":"integer","description":"Number of installments for the payment"},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"description":"Type of delivery selected"},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments"},"cargo_company":{"type":"integer","description":"ID of the company responsible for shipping"},"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":"uri","description":"URL for the e-archive of the invoice"},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order"},"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"},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent"},"net_shipping_amount":{"type":"number","format":"decimal","description":"Net shipping amount","readOnly":true},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost"},"tracking_number":{"type":"string","description":"Tracking number for the order"},"carrier_shipping_code":{"type":"string","description":"Shipping code from the carrier"},"remote_addr":{"type":"string","description":"IP address from where the order was placed"},"fundstransfertransaction_set":{"type":"array","items":{"type":"integer"},"description":"Set of funds transfer transaction IDs"},"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":{"type":"integer","description":"ID of the external status"},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order"},"language_code":{"type":"string","description":"Language code for the order"},"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"},"modified_date":{"type":"string","format":"date-time","description":"Last modification date of the order"},"checkout_provider_id":{"type":"integer","description":"ID of the provider used for checkout"},"created_date":{"type":"string","format":"date-time","description":"Creation date of the order"},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order"},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany","readOnly":true},"cancel_status":{"$ref":"#/components/schemas/CancelStatusEnum","readOnly":true},"defined_tracking_url":{"type":"string","format":"uri","description":"Custom tracking URL"},"installment_free":{"type":"boolean","description":"Whether installment is free","readOnly":true},"first_refund_strategy":{"type":"string","description":"First refund strategy","readOnly":true}}},"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"},"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"]},"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"]}}}} ``` ## The SalesChannelCategoryTree object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/CategoryTree"}]},"CategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNode"}}},"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."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}}}} ``` ## The SalesChannelCategoryTreeDetailed object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SalesChannelCategoryTreeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/CategoryTreeDetailed"}]},"CategoryTreeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNodeDetailed"}}},"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."}}},"CategoryNodeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"object","$ref":"#/components/schemas/SortOptionDetailed"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}},"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]}}}} ``` ## The CurrencyEnum object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"}}}} ``` ## The CancelStatusEnum object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancelStatusEnum":{"type":"string","description":"Cancellation status of the order item","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]}}}} ``` ## The ShippingCompany object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The CancellationType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationType":{"type":"string","description":"Type of cancellation","enum":["cancel","refund"]}}}} ``` ## The CancellationRequestStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationRequestStatus":{"type":"string","description":"Status of the cancellation request.","enum":["open","waiting","confirmation_waiting","confirmed","waiting_approval","approved","rejected","waiting_for_payment","manuel_refund_need","completed"]}}}} ``` ## The CancellationEasyReturnStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationEasyReturnStatus":{"type":"string","description":"Status of the cancellation easy return.","enum":["active","cancelled"]}}}} ``` ## The ClientType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ClientType":{"type":"string","description":"Type of client","enum":["default","android","ios","instore","b2b"]}}}} ``` ## The IntegrationMappingType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The AddressType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}}}} ``` ## The OrderAddressType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OrderAddressType":{"type":"string","description":"Type of order address","enum":["shipping_address","billing_address"]}}}} ``` ## The OfferType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"OfferType":{"type":"string","description":"Type of offer","enum":["session_offer","basket_offer"]}}}} ``` ## The SessionOfferType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The TransactionType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"]}}}} ``` ## The TransactionResponseStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"TransactionResponseStatus":{"type":"string","description":"Status of the transaction response","enum":["pending","approved","rejected"]}}}} ``` ## The ShippingOptionDeliveryType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ShippingOptionDeliveryType":{"type":"string","description":"Delivery type for shipping options","enum":["same_day","next_day","standard","in_store"]}}}} ``` ## The PayOnDeliveryTransactionType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"PayOnDeliveryTransactionType":{"type":"string","description":"Type of pay on delivery transaction","enum":["purchase","refund","cancel"]}}}} ``` ## The FundsTransferTransactionStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"FundsTransferTransactionStatus":{"type":"string","description":"Status of the funds transfer transaction","enum":["payment_waiting","paid","cancelled"]}}}} ``` ## The PayOnDeliveryTransactionStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"PayOnDeliveryTransactionStatus":{"type":"string","description":"Status of the pay on delivery transaction","enum":["payment_waiting","paid","cancelled"]}}}} ``` ## The LoyaltyTransactionType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"LoyaltyTransactionType":{"type":"string","description":"Type of loyalty transaction","enum":["purchase","refund"]}}}} ``` ## The BexTransactionType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BexTransactionType":{"type":"string","description":"Type of Bex transaction","enum":["connection","ticket","availability","purchase"]}}}} ``` ## The ChannelType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"ChannelType":{"type":"string","description":"Type of the channel","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]}}}} ``` ## The CancellationPlanStatus object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationPlanStatus":{"type":"string","description":"Status of the cancellation plan","enum":["completed","waiting","waiting_supplier","approved","confirmation_waiting","confirmed","cancelled","failed","rejected","waiting_for_payment","manuel_refund_need"]}}}} ``` ## The CancellationPlanType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CancellationPlanType":{"type":"string","description":"Type of cancellation plan","enum":["cancel","refund"]}}}} ``` ## The CashRegisterTransactionType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"CashRegisterTransactionType":{"type":"string","description":"Type of cash register transaction","enum":["purchase","refund","cancel"]}}}} ``` ## The B2BTransactionType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"B2BTransactionType":{"type":"string","description":"Type of B2B transaction","enum":["purchase","refund","cancel"]}}}} ``` ## The BulkProcessStatusEnum object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BulkProcessStatusEnum":{"type":"string","description":"Status of the bulk process","enum":["waiting","in_progress","completed"]}}}} ``` ## The Entity object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}}}}} ``` ## The MP\_Node object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}}}} ``` ## The IntegrationRelation object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The StarterModel object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"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."}}}}}} ``` ## The UUIDStarterModel object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"UUIDStarterModel":{"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."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}}}}} ``` ## The BulkProcessStatusResponse object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"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"]}}}} ``` ## The PaymentType object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"PaymentType":{"type":"object","enum":["credit_card","funds_transfer","pay_on_delivery","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","saved_card","pay_later","confirmation","b2b","wallet"],"description":"Status of the payment type."}}}} ``` ## The BulkObjTagOperations object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BulkObjTagOperations":{"type":"object","properties":{"objs":{"type":"array","items":{"type":"integer"},"description":"List of object IDs to which tags will be added."},"keys":{"type":"array","items":{"type":"string"},"description":"List of tag keys to add to the objects."}},"required":["objs","keys"]}}}} ``` ## The SimpleTagOperations object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"SimpleTagOperations":{"type":"object","properties":{"key":{"type":"string","description":"Tag key to add to the object."}},"required":["key"]}}}} ``` ## The BulkTagOperations object ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"components":{"schemas":{"BulkTagOperations":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"},"description":"List of tag keys to add to the objects."}},"required":["keys"]}}}} ```