CaptureOrder

Capture Order

post

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

Authorizations

Token

AuthorizationstringRequired

Body

application/json

orderstringOptional

Order Number

Example: ORDER12345

Responses

200

Order captured successfully

application/json

401

Unauthorized Access

application/json

post

/api/v1/capture-order/

HTTPcURLJavaScriptPython

POST /api/v1/capture-order/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "order": "ORDER12345",
  "order_items": []
}

{
  "pk": 1,
  "number": "ORDER12345",
  "channel": 1,
  "customer": 1,
  "date_placed": "2024-11-20T11:22:23.702774Z",
  "extra_field": {
    "special_note": "Handle with care"
  },
  "payment_option": 1,
  "payment_option_slug": "credit-card",
  "bin_number": "123456",
  "installment": 1,
  "installment_count": 6,
  "installment_interest_amount": 50,
  "cargo_company": 1,
  "is_send": false,
  "delivery_type": "next_day",
  "cancellation_info": {
    "reason": "Customer requested cancellation"
  },
  "cancel_status": "cancelled",
  "shipping_interest_amount": 10,
  "external_status": 1,
  "client_type": "default",
  "carrier_shipping_code": "TRACK12345",
  "segment": "premium",
  "checkout_provider_id": 12345,
  "status": 200,
  "currency": "try",
  "amount": 1000,
  "discount_amount": 50,
  "shipping_amount": 20,
  "shipping_tax_rate": 18,
  "refund_amount": 100,
  "discount_refund_amount": 10,
  "shipping_refund_amount": 5,
  "invoice_number": "INV123456",
  "invoice_date": "2024-11-21T11:22:23.702774Z",
  "e_archive_url": "https://earchive.example.com/invoice/123",
  "tracking_number": "TRACK12345",
  "defined_tracking_url": "https://tracking.example.com/track/123",
  "shipping_company": "yurtici",
  "remote_addr": "192.168.0.1",
  "has_gift_box": false,
  "gift_box_note": "Happy Birthday!",
  "language_code": "en",
  "notes": "Leave at the front door.",
  "delivery_range": {
    "start": "2026-01-19T23:30:21.921Z",
    "end": "2026-01-19T23:30:21.921Z"
  },
  "shipping_option_slug": "standard-shipping",
  "created_date": "2026-01-19T23:30:21.921Z",
  "modified_date": "2026-01-19T23:30:21.921Z"
}