# CaptureOrder

## Capture Order

> Capture an order by providing the order number and the items to be captured.

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"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"}}},"Order":{"type":"object","required":["number","channel","customer","date_placed","amount","status"],"properties":{"pk":{"type":"integer","description":"Unique identifier for the order."},"number":{"type":"string","description":"Order number, unique within the context of a channel."},"channel":{"type":"integer","description":"ID of the channel associated with the order."},"customer":{"type":"integer","description":"ID of the customer who placed the order."},"date_placed":{"type":"string","format":"date-time","description":"Timestamp when the order was placed."},"extra_field":{"type":"object","additionalProperties":true,"description":"Additional information about the order."},"payment_option":{"type":"integer","description":"ID of the payment option used for the order."},"payment_option_slug":{"type":"string","nullable":true,"description":"Slug of the payment option."},"bin_number":{"type":"string","nullable":true,"description":"First 6 digits of the customer's card used in the transaction."},"installment":{"type":"integer","description":"ID of the installment object used for the order."},"installment_count":{"type":"integer","nullable":true,"description":"Number of installments for the payment."},"installment_interest_amount":{"type":"number","format":"decimal","description":"Interest charged on installment payments."},"cargo_company":{"type":"integer","description":"ID of the cargo company used for shipping."},"is_send":{"type":"boolean","description":"Indicates whether the order has been sent."},"delivery_type":{"type":"string","enum":["same_day","next_day","standard","in_store"],"nullable":true,"description":"Type of delivery selected for the order."},"cancellation_info":{"type":"object","description":"Details regarding the cancellation of the order."},"cancel_status":{"type":"string","enum":["waiting","confirmation_waiting","confirmed","approved","rejected","waiting_for_payment","manuel_refund_need","completed"],"nullable":true,"description":"Status of the order cancellation."},"shipping_interest_amount":{"type":"number","format":"decimal","description":"Interest applied to the shipping cost."},"external_status":{"type":"integer","description":"ID of the external status associated with the order."},"client_type":{"type":"string","enum":["default","android","ios","instore","b2b"],"description":"Type of client placing the order."},"carrier_shipping_code":{"type":"string","nullable":true,"description":"Tracking code assigned by the carrier."},"segment":{"type":"string","nullable":true,"description":"Customer segment for the order."},"checkout_provider_id":{"type":"integer","nullable":true,"description":"ID of the provider used for checkout."},"status":{"type":"string","description":"Status of the order","enum":[50,100,200,300,350,400,450,500,510,520,540,544,545,546,547,550,600]},"currency":{"type":"string","description":"Currency type for the order, following ISO 4217 currency codes.","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"]},"amount":{"type":"number","format":"decimal","description":"Total amount for the order."},"discount_amount":{"type":"number","format":"decimal","description":"Discount applied to the order."},"shipping_amount":{"type":"number","format":"decimal","description":"Shipping charge for the order."},"shipping_tax_rate":{"type":"number","format":"decimal","nullable":true,"description":"Tax rate applied to the shipping charge."},"refund_amount":{"type":"number","format":"decimal","description":"Total refund amount for the order. Shipping refund amount included."},"discount_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the discount."},"shipping_refund_amount":{"type":"number","format":"decimal","description":"Refund amount for the shipping."},"invoice_number":{"type":"string","nullable":true,"description":"Invoice number for the order."},"invoice_date":{"type":"string","format":"date-time","nullable":true,"description":"Invoice date for the order."},"e_archive_url":{"type":"string","format":"url","nullable":true,"description":"URL for the e-archive of the invoice."},"tracking_number":{"type":"string","nullable":true,"description":"Tracking number for the order."},"defined_tracking_url":{"type":"string","format":"url","nullable":true,"description":"URL for tracking the order."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"remote_addr":{"type":"string","format":"ipv4","nullable":true,"description":"IP address from where the order was placed."},"has_gift_box":{"type":"boolean","description":"Indicates whether the order has a gift box."},"gift_box_note":{"type":"string","nullable":true,"description":"Message for the gift box."},"language_code":{"type":"string","nullable":true,"description":"Language code for the order."},"notes":{"type":"string","nullable":true,"description":"Customer instructions for the order."},"delivery_range":{"type":"object","description":"Date range for delivery.","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"shipping_option_slug":{"type":"string","nullable":true,"description":"Slug for the shipping option."},"created_date":{"type":"string","format":"date-time","description":"Creation Date"},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date"}}},"ShippingCompany":{"type":"string","description":"Shipping company options","enum":["aras","ups","asil","yurtici","mng","hbexpress","aramex","other","ismail","gls","hoopkapida","fancourier","tmmexpress","ptt","horoz","novaposhta","droplight","surat","ups_intl","b2c_direct","jetizz","tyexpress","ay_cargo","cainiao","acs","packupp","k_gelsin","birgunde","kargo_ist","giz","mylerz","mylerzsdd","r2s","boomex","chrono","scotty","netkargo","murat_lgc","fast_cargo","dpd","in_post","k_sende","rupost","cdek","loomis","carrtell","speeta","bringo","dhlexpress","bovo","gelal","arvato","bpost_athome","bpost_24_7","cathedis","dincer","sameday","gkn","svuum","hjetxl","aramex_express","tnt_cargo","ceva_cargo","bringo_express","sendeo","cargus","pinkpost","speedy","deliverigo","jetizz_v7","evdemo_lojistik","extension","apiship","octovan_express","clickpost","iMile","jetlogi","bolt","pony_express","boxaty","monist","city_express","fero_ai","carriyo","pakettaxi","falcon_flex","porter_express","sky_express","pts_express","bpost_pickup"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}}}},"paths":{"/api/v1/capture-order/":{"post":{"summary":"Capture Order","description":"Capture an order by providing the order number and the items to be captured.","tags":["CaptureOrder"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureOrderSerializer"}}}},"responses":{"200":{"description":"Order captured successfully","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Order"}}}},"401":{"$ref":"#/components/responses/401"}}}}}}
```